https://github.com/muhammadusman-10/chatbot-project
A Mental Health Assistance Chatbot developed for an end-user using React & Python.
https://github.com/muhammadusman-10/chatbot-project
chromadb fastapi langchain openai python reactjs
Last synced: 3 months ago
JSON representation
A Mental Health Assistance Chatbot developed for an end-user using React & Python.
- Host: GitHub
- URL: https://github.com/muhammadusman-10/chatbot-project
- Owner: MuhammadUsman-10
- License: mit
- Created: 2025-01-06T18:00:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-14T23:13:56.000Z (over 1 year ago)
- Last Synced: 2025-01-20T22:58:11.156Z (over 1 year ago)
- Topics: chromadb, fastapi, langchain, openai, python, reactjs
- Language: JavaScript
- Homepage: https://chatbot-project-ten-steel.vercel.app
- Size: 2.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chatbot-Project 🚀
## Project Overview
This Chatbot is developed to assist people to feel good while sharing their feelings, emotions, their life experiences, if having some bad thoughts or some positive thoughts, it can provide support in that. Basically, the obejctive behind developing this chatbot was to help people who feel low, or overwhelmed in their lives due to the bad life experiences they had in their life due to which they feel stress, have tensions & depression or anxiety problems.
## Project Members
1. Washma Tabassum - 21pwbcs0829
2. Muhammad Usman - 21pwbcs0848
## Project Tech-Stack & Deployment
### 1. Tech Stack
- The Project is developed using
1. **React.js** & **TailwindCSS**
2. **React SpeechRecognition Library for Voice Input**
2. **MongoDB Atlas for Database**
3. **Python**
4. **OpenAI Model**
5. **langchain for LLM chaining and chatHistory for memory context**, and **chromaDB for embeddings**.
- The Model is being fine-tuned on the provided JSON data and generates response based on the similarity search between stored emeddings and the user input.
### 2. Deployment
- The frontend is being deployed on [Vercel](https://vercel.com) using default build production.
- The backend is beinf deployed on [Railway](https://railway.com) using Docker containerization tool.
## Project Setup
### Backend
- goto backend folder using command: "**cd backend**"
- create the environment by the following command:
"**python -m venv env**"
- activate the environment using command: "**env\scripts\activate**" if using cmd in windows.
- if using powershell, then try using command: "**env\scripts\activate.ps1**" for activation of environment.
- install the mentioned dependencies mentioned in requirements.txt file by using the command: "**pip install -r requirements.txt**"
- create a file named "**.env**" and add your **OPENAI_API_KEY** & **MONGO_URI** in it.
- run the backend server by using command: "**uvicorn chatbot_api:app**"
### Frontend
- goto frontend folder using command: "**cd frontend**"
- install all the node modules by: "**npm i**"
- run the frontend server using command: "**npm run dev**"
### Database - MongoDB
- install mongoDB, if not installed
- connect mongoDB with the chatbot
- create variable **MONGO_URI** in .env with the mongoDB localhost URI.
#### Note: This Project is under MIT Licence. So, if anyone wants to add features or want to contribute, create a PR for your input and will be then merged if found useful.
#### If found some issues in current release, please raise in issue and create a PR for it.
### Thank You Everyone! - enjoy 😁