README.md

FindR

A cross-platform price comparison app that transforms your e-shopping experience.

⭐ Getting Started

Navigate to your working directory:

cd <PATH>/<WORK_DiR>

Clone the GitHub repository:

git clone https://github.com/Neo-Zenith/FindR-E-Commerce-Price-Comparison-App.git

Navigate to the local repo directory:

cd FindR-E-Commerce-Price-Comparison-App

Checkout on different branches:

• For main branch:

git checkout main

• For dev branch:

git checkout dev

🚧 Branches

• main branch holds all confirmed development
• dev branch is the branch for new and work-in-progress developments.

📁 File Structure

~
├── .vscode                         # Azure settings
├── deliverables                    # Lab deliverables
├── dev
│    ├── client                     # React app
│    ├── core                       # Server API
|    ├── jobs                       # Django scheduler
|    ├── scripts                    # Web scrapping tool
|    ├── server                     # Django server
│    ├── requirements.txt           # Project dependencies
│    ├── README.md
│    └── manage.py
├── .gitignore
└── README.md

🛠️ Tech Stack

📄 FindR API Documentations

• Accounts Endpoints
• Friends Endpoints
• Main Endpoints