coderacheal/Sunday

Sunday is a react app embed with a machine learning model that warns users about the context of their message before they send them.

Sunday

📗 Table of Contents

• 📗 Table of Contents
• Sunday
  • 🛠 Built With
    • Tech Stack
  • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Link to Model
    • Spin Up Docker containerl
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

Sunday

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

🛠 Built With

Tech Stack

Client

• React

Server

• Nodemon

• Express

Model

• Huggingface Mobilebert from Google

Socket

• Socket.io

API

• FastAPI

(back to top)

Key Features

• Creates a connection between two users
• Can detect the sentiment of a message
• Give user meaningul insights before sending the message

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node V18

Example command:

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-project
  git clone https://github.com/coderacheal/sunday.git

Install

Install this project with:

Example command:

  cd sunday

  npm install

Usage

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

Link to Model

Please find a link to the model hosted in Huggingface here

Spin Up Docker container

• 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

👥 Authors

🕵🏽‍♀️ Racheal Appiah-kubi

• GitHub: GitHub Profile
• Twitter: Twitter Handle
• LinkedIn: LinkedIn Profile

(back to top)

🔭 Future Features

• Add chat history.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project kindly show some love, give it a 🌟 STAR 🌟

(back to top)

🙏 Acknowledgments

I would like to thank all the free available resource made available online

(back to top)

📝 License

This project is MIT licensed.

(back to top)