diff --git a/README.md b/README.md index b3e3520..95305d7 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,57 @@ CS59000-03 Group Project for Course > * Quick response with even quicker turn around time. > * Should be accurate. +## Tech Stack: +> * Python +> * Flask +> * React +> * PaLM API +> * Playwright +> * JSON + ## Creators: > * @sanidhyaRsharma > * @staticowl > * @knsspsj19 > * @dannypz97 -##Prerequisites: +## Prerequisites: > 1. keyboard-0.13.5 (from pip) > 2. Python (>=3.10) -##Important Instructions: +## Installation: +> 1. Clone the repository +> 2. Two ways to install backend dependencies the program, after you go to the backend directory. +>> 1. Run `python3 app.py -s` in the terminal. This will trigger the setup script which will install all the dependencies required. +>> 2. Or you can run `pip3 install -r requirements.txt` to install all the dependencies. +> 3. For the frontend, go to the frontend directory and run `npm install` to install all the dependencies. + +## Usage: +> 1. Run the backend: +>> 1. First Time Users, collect the data using `python3 app.py -sc` in the terminal. This will collect the data from the URLs mentioned in the `urls.txt` file. +>> 2. Run the program using `python3 app.py` in the terminal. This will start the backend of the program. +> 2. Run the frontend using `npm start` in the terminal. + +And VoilĂ ! You should be able to access the chatbot in localhost. + +## Important Instructions: > * Have used `esc` as a default escape button for any and every operation in the program. +## Features: +> * PaLM API is currently being used for the chatbot. +> * The chatbot is currently trained on the data collected from the URLs mentioned in the `urls.txt` file. +> * The chatbot currently only supports the following topics: +>> * Courses +>> * Faculty +>> * Research +>> * Credits +>> * Contact +> * It also produces a confidence score for the response it gives. +> * In case the chatbot doesn't know anything in particular, it will redirect you to the relevant person to contact. + ## Tasks: +>* Feel free to add any task you think is important. + | Task | SubTask | Assigned to | Current Status | |-------------------------------|---------------------|------------------------|----------------| | Approval Procedure | - | All | [x] | @@ -36,9 +73,10 @@ CS59000-03 Group Project for Course | Integrate Front-end back-end | React | @sanidhyaRsharma | [x] | | Integrate Back-end with model | Flask | @dannypz97 | [x] | | Model | Model Type Finalize | @knsspsj19, @staticowl | [x] | -| Model | PreProcessing | @knsspsj19, @staticowl | [] | -| API | Context | @dannypz97 | [] | -| Data | Scraping URL List | All | [] | +| Model | PreProcessing | @knsspsj19, @staticowl | [x] | +| API | Context | @dannypz97 | [x] | +| Data | Scraping URL List | All | [x] | | Convert UI to Modal | Move Chat component | @sanidhyaRsharma | [x] | | Setting up login/signup | Login | @sanidhyaRsharma | [x] | | Setting up login/signup | Sign Up | @sanidhyaRsharma | [x] | +| Data Collection | Scrapping Config | @staticowl | [x] | diff --git a/backend/app.py b/backend/app.py index a27bfa6..8a63953 100644 --- a/backend/app.py +++ b/backend/app.py @@ -5,7 +5,6 @@ sys.path.append('.') parser = argparse.ArgumentParser() - parser.add_argument('--train', '-t', action='store_true', help='train the model') parser.add_argument('--setup', '-s', action='store_true', help='setup the project') parser.add_argument('--scraping', '-sc', action='store_true', help='scraping the data from list of urls')