Giter Club home page Giter Club logo

pls-hire-me-original's Introduction

Market Scope

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.

Table of Contents

  1. Features
  2. Setup Instructions
  3. Usage Instructions
  4. Deployment Instructions

Features

Search Company Name

  • You may search multiple company names by seperating the names with a comma

Report

  • Generates a report for the company's main products or services, business strategies, and market perception

Getting Started

These instructions will guide you through the process of setting up and running the application on your local machine for development and testing purposes.

Prerequisites

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.

Setup Instructions

Backend

The backend is a Python Flask application.

  1. Clone the repository to your local machine:

    git clone https://github.com/keshao728/pls-hire-me.git
  2. Navigate to the backend directory:

    cd app
  3. Install Python dependencies:

    pip install -r requirements.txt
  4. Create the local server env file, replace the key to your API keys:

    cp .env.example .env.local
  5. Start the application:

     python app.py

    This will start the server on localhost:5003. The server endpoint is /process, which accepts POST requests.

Frontend

The frontend is a React application.

  1. Navigate into the frontend directory:
    cd react-app
  2. Install Node.js dependencies:
    npm install
  3. Start the application
     npm start
    This will start the React application and open it in your default web browser at http://localhost:3000.

Usage Instructions

  • 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.

Deployment Instructions

  • Work in progress

Note: Don't forget to secure your API keys before deploying the application to a production environment.

pls-hire-me-original's People

Contributors

keshao728 avatar

Stargazers

Prabhjot (PJ) Singh avatar Gary Song avatar  avatar David Chou avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.