Market Scope is a comprehensive AI-Powered Market Detective tool designed to provide insights into your competition. By leveraging modern technologies like Flask, React, OpenAI, and Google APIs, it uncovers valuable information about your competitors such as their main products or services, business strategies, and market perception.
This tool conducts deep-dive searches using Google's Custom Search API, segmenting the obtained data into manageable chunks for further analysis. It uses OpenAI's advanced NLP models to generate an informative report, delivering data-rich insights to your fingertips.
- You may search multiple company names by seperating the names with a comma
- Generates a report for the company's main products or services, business strategies, and market perception
These instructions will guide you through the process of setting up and running the application on your local machine for development and testing purposes.
Ensure you have the following installed on your local development machine:
- Python 3.8 or later
- Node.js and npm
- Flask
- React
Also, make sure to acquire API keys for OpenAI, Google APIs and Programmable Search Engine ID and store them in a .env
file, an .env.example
is provided at the /app
of the project directory.
The backend is a Python Flask application.
-
Clone the repository to your local machine:
git clone https://github.com/keshao728/pls-hire-me.git
-
Navigate to the backend directory:
cd app
-
Install Python dependencies:
pip install -r requirements.txt
-
Create the local server env file, replace the key to your API keys:
cp .env.example .env.local
-
Start the application:
python app.py
This will start the server on localhost:5003. The server endpoint is
/process
, which accepts POST requests.
The frontend is a React application.
- Navigate into the frontend directory:
cd react-app
- Install Node.js dependencies:
npm install
- Start the application
This will start the React application and open it in your default web browser at http://localhost:3000.
npm start
- Open your web browser and go to http://localhost:3000 (or the port you configured for your React app).
- You'll see an input field where you can enter the names of the companies you want to investigate, separated by commas.
- After entering the company names, click the 'Submit' button.
- The application will then generate a report for each company, which will include information about their main product or service, business strategy, and market perception.
- Work in progress
Note: Don't forget to secure your API keys before deploying the application to a production environment.