Sunday is a chat app embed with a NLP transformer model from huggingface. The app predicts sentiment ans probability of the sentiment before and allow users to decide if they still want to send the text giving the information.
Sunday predicts five (5) sentiments
- Positive
- Negative
- Neutral
- Litigious
- Uncertainty
Want to know what your texts convey? Try Sunday
Note that is a pure NLP projects designed and built for eduction and academic purposes
Client
Socket
API
- Creates a connection between two users
- Can detect the sentiment of a message
- Give user meaningul insights before sending the message
To get a local copy up and running, follow these steps.
In order to run this project you need:
- Node V18
Example command:
Clone this repository to your desired folder:
Example commands:
cd my-project
git clone https://github.com/coderacheal/sunday.git
Install this project with:
Example command:
cd sunday
npm install
To run the Frontend:
Example command:
cd client
npm start
OR
cd client
npm run start
To run the Backend:
Example command:
cd server
nodemon src/index.js
To run the API:
Example command:
cd api
uvicorn main:app --reload
Please find a link to the model hosted in Huggingface here
- Start the docker engine using the Docker desktop application
- Once started open the terminal for the project
RUN
docker-compose build
Once the image is done built
RUN
docker-compose up
🕵🏽♀️ Racheal Appiah-kubi
- GitHub: GitHub Profile
- Twitter: Twitter Handle
- LinkedIn: LinkedIn Profile
- Add chat history.
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project kindly show some love, give it a 🌟 STAR 🌟
I would like to thank all the free available resource made available online
This project is MIT licensed.