SerenityJS

Racial Micro-aggression detection
Link to frontend

Table of Contents

• About the Project
  • Routes
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License

About The Project

This project is a project based on machine learning and natural language processing which is integrated together with NodeJS to develop a RESTful API that detects the presence of racial microaggression in an input sentence.

Routes

Sr. No	Description
1. Check an input	Get request on route '/predict' to check whether there are traces of hate speech in an input or not.

Built With

• Node JS
• Python
• React JS

Getting Started

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

Prerequisites

• node js
  
  

Installation and Setup

1. Clone the repo

git clone https://github.com/Shiv10/serenity.git

2. Change directory to Appointy-instagram-clone

cd ./serenity/Backend

3. Install the node modules

npm i

4. Create .env file and add data from the sample env (not needed if zip archive is provided)

touch .env && nano .env

5. Start backend server in development mode

npm run dev

6. Clone the repo

 git clone https://github.com/shaarangg/serenityjsFrontend.git

8. Change directory

 cd ./serenityFrontend

8. Start the frontend server

 npm run start

Usage

1. Open the frontend in the broswer and you will be greeted with a screen as below.

2. Write your text in the given text area and press the submit button to get according response.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Flow of contributions

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push -u origin feature/AmazingFeature)
5. Open a Pull Request

Happy Coding 😄