Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blacksujit/relaxrover
RelaxRover is a chatbot designed to provide stress and anxiety relief through conversational interactions. It utilizes the latest Mistral Model and natural language processing (NLP) models to offer supportive and calming responses to users seeking help.
https://github.com/blacksujit/relaxrover
ai anxiety-reduction artificial-neural-networks db developer-quiz fine-tuning gpt-4 hackathon llama llama3 llms mental-health-awareness mistral-7b models openai-api personalassistant quira stress-relief
Last synced: 16 days ago
JSON representation
RelaxRover is a chatbot designed to provide stress and anxiety relief through conversational interactions. It utilizes the latest Mistral Model and natural language processing (NLP) models to offer supportive and calming responses to users seeking help.
- Host: GitHub
- URL: https://github.com/blacksujit/relaxrover
- Owner: Blacksujit
- Created: 2024-08-06T22:11:11.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-04T17:32:59.000Z (16 days ago)
- Last Synced: 2024-11-04T18:32:08.873Z (16 days ago)
- Topics: ai, anxiety-reduction, artificial-neural-networks, db, developer-quiz, fine-tuning, gpt-4, hackathon, llama, llama3, llms, mental-health-awareness, mistral-7b, models, openai-api, personalassistant, quira, stress-relief
- Language: Python
- Homepage:
- Size: 13.2 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Relax Rover
## Overview:
## **Stress and Anxiety Relif Bot** :
RelaxRover is a chatbot designed to provide stress and anxiety relief through conversational interactions. It utilizes the latest Mistral model and natural language processing (NLP) models to offer supportive and calming responses to users seeking help.
## Table of Contents:
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
# Folder Structure:
```
project_root/
│
├── frontend/
│ ├── index.html
│ ├── static/
│ ├── css/
│ │ └── styles.css
│ └── js/
│ └── script.js
│
├── backend/
| | models/
| | chatgpt_model.py
| | llama_model.py
│ ├── app.py
│ └── bot_logic.py
│
└── venv/ (virtual environment)
|___ .env
```
## Working Video and images of Web app:
https://github.com/user-attachments/assets/5341dd16-e591-4120-b1d7-0cddd056a56c
## Images:
## Custom code function and bot logic added by me for mood:
## Features
- **Conversational Support:** Engage in conversations focused on stress relief and mental well-being.
- **AI-Powered Responses:** Leverage advanced NLP models for insightful and empathetic replies.
- **User-Friendly Interface:** A simple web interface for easy interaction with the bot.
- **Log Your Mood:** You can also log your mood. it will displayed as an level of feelings you are having on the anxiety bar
## Installation
### Prerequisites
- Python 3.8+
- Pip (Python package manager)
- A valid Mistral API Key
### Setup
1. **Clone the repository:**
```bash
git clone https://github.com/Blacksujit/RelaxRover_Anxiety_Relif_Bot
```
2. **Create a virtual environment and activate it:**
```
python -m venv venv
```
```
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. **Install the required packages:**
```
pip install -r requirements.txt
```
4. **Set up environment variables:**
`Create a .env file in the root directory and add your mistral API and other api key:`
`MISTRAL_API_KEY` = 'your_mistral_ai_api_key'
`LOGIN_KEY` = 'your_login_token_from_hugging_face'
5. **Start the Flask server:**
```
python backend/app.py
```
# **API Reference**:
> get this credentials from specific platforms.
Open_ai_api_key = https://platform.openai.com/settings/profile?tab=api-keys
login_key_from_hugging_face = https://huggingface.co/settings/tokens
Mistral_api_Key = https://chat.mistral.ai/chat/f49eac86-1d65-4adb-8d8e-c242941c5d9b
# **Contributing**:
Contributions are welcome! Please fork the repository and submit a pull request with your improvements or fixes. For major changes, please open an issue to discuss your ideas first.
Fork the repository.
Create a `.env ` file in the root directory and add your mistral API and other api key:
1.) Create a new branch `(git checkout -b feature-branch).`
2.) Commit your changes `(git commit -am 'Add new feature').`
3.) Push to the branch` (git push origin feature-branch).`
4.) Create a new Pull Request.
# **License**:
This project is licensed under the MIT License.
# **Contact**:
For any inquiries or issues, please reach out to:
Author: Sujit Nirmal
Email: [email protected]
GitHub: @blacksujit