Phone Matchup

Overview

Welcome to Phone Matchup! Phone Matchup is a ETL Pipelines designed to extract and Standardize Smart Phone data. Whether you are a developer or contributor, this README.md will guide you through the essentials of the project.

Table of Content

1. Introduction
2. Getting Started
3. Installation
4. Contribution

Introduction

Phone Matchup crafts an advanced ETL Pipeline designed to efficiently Extract, Standardize, and meticulously Process Smart Phone Data, tailoring the results to suit the user's budget preferences and specific brand preferences, delivering a seamless experience.

Getting Started

Before diving into the project, ensure you have the following prerequisites:

• Programming Language: Python 3.X
• Package Manager: pip
• Version Control: Git
• Integrated Development Environment: Visual Studio Code, PyCharm

Installation

1. Clone Repository

   https://github.com/Arko-Sengupta/Phone-Matchup.git

2. Navigate to the Project Directory

   cd/<Project-Directory>

3. Install Dependencies

   pip install -r requirements.txt

4. For Testing the Pipeline find .env file. The default value of TEST would be None as it's going to extract all the Smart Phone Data. Therefore, to save time limit the Data to 100.

   TEST="100"

5. Start Backend Server

   python ETLPipe_API.py

6. Confirm Server Start: Open the below URL at Browser: http://localhost:5000/

7. Start the Application

   streamlit run App.py

Contribution

If you'd like to contribute, follow the guidelines

• Create a branch using the format Phone-Matchup_<YourUsername> when contributing to the project.
• Add the label Contributor to your contributions to distinguish them within the project.