Virtual-Mentor

Table of Contents

• About
• Setting up the environment
• Running the application
• application routes
• API Documentation
• To-Do
• Contributors
• License

About

MentorGPT is a web application that uses a chatbot to answer questions about the Python, Data Science, Machine Learning. The chatbot is connected to OpenAI's GPT-3 API. The application is built using Python, Flask and Vue.

Setting up the environment

You should have the following installed on your machine:

• python 3.10
• flask 2.2.3
• flask-cors 3.0.10

Running the application

• Clone the repository

git clone https://github.com/Mahhheshh/MenotGPT.git

• Create a virtual environment

pip install pipenv 
pipenv shell

• Install the dependencies

pipenv install

• Run the application

python main.py

• Open the application in your browser

http://localhost:5000/

application routes

• GET /

http://localhost:5000/

• POST /ask

http://localhost:5000/ask

API Documentation

• POST /ask, request body

{
    "question": "What is difference between lists and tuPle"
}

• POST /ask, response body

    Returns a stream of data using Server-Sent Events.

setting up the environment(frontend)

• Install the dependencies

cd frontend
npm install

• Run the application

npm run dev -- --open 

To-Do

• [ ] beautify the UI

Contributors

Contributions are welcome. Please open an issue or submit a pull request.

License

MIT

made with ❤️ by Mahesh