Spotter App for Business Location Ranking

The Spotter App is a tool that helps entrepreneurs and business owners evaluate potential business locations. It collects business details through a form, such as business name, type, location, target customers, and company scale. Upon submission, users can choose specific locations on a Leaflet map where they plan to start their business. The backend of the app then provides ranked locations based on sustainable factors, including nearby competitors' ratings and the number of ratings, using the Selenium package in Python with Flask. The frontend is built with React.js.

The main idea is to calculate a weighted ranking score for each location, considering factors such as competitor ratings, number of ratings, and distance. Here's a breakdown of the process:
The details of near by competitors, their rating, distance and number of rating are scarpped from Google maps using selenium package.This obtained details are then used to rank for the each location based on the formula

$$Score = \sum_{} \left( Rating \times number of ratings \right) \div distance$$ The lower the score, the higher the location is Ranked.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Running the App
  • Frontend (React.js)
  • Backend (Flask)
• Usage
• Contributing
• Acknowledgments

Getting Started

Prerequisites

To run the Spotter App, you need to have the following software installed on your machine:

• Node.js and npm (Node Package Manager)
• Python 3.x
• Chrome WebDriver (for Selenium)

Installation

1. Clone this repository to your local machine:

   git clone https://github.com/your-username/spotter-app.git
   cd spotter-app

2. Install the required dependencies for the frontend:

   cd frontend
   npm install

3. Install the required dependencies for the backend:

   cd backend
   pip install -r requirements.txt

Running the App

Frontend (React.js)

1. Navigate to the frontend directory:

   cd frontend

2. Start the React app:

   npm start

   This will run the app in development mode. Open http://localhost:3000 to view it in your browser.

Backend (Flask)

1. Open a new terminal and navigate to the backend directory:

   cd backend

2. Start the Flask app:

   python app.py

   The Flask app will run on http://localhost:5000.

Usage

1. Access the Spotter App in your web browser by going to http://localhost:3000.

2. Fill out the form with your business details and choose specific locations on the map.

3. Submit the form to receive ranked locations based on sustainable factors.

Contributing

We welcome contributions from the community! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.

Acknowledgments

• This project was inspired by the need for entrepreneurs to make informed decisions about their business locations.
• Thanks to the open-source community for providing the tools and libraries that made this project possible.

---

Feel free to modify the README according to your specific project details. Make sure to update placeholders like your-username and provide accurate and relevant information about your project.