Serenity

Real-time chat integrated with toxicity filters

How to run the project?

Prerequisite

• Install Node.js (12.x) and NPM

  For Windows, https://treehouse.github.io/installation-guides/windows/node-windows.html

  For Linux, https://linuxize.com/post/how-to-install-node-js-on-ubuntu-18.04/

• Install Cordova

  For Windows, https://evothings.com/doc/build/cordova-install-windows.html

  For Linux, sudo npm install -g cordova

• Install Ionic

  npm install -g ionic (Linux may ask for permission, in this case, use: sudo npm install -g ionic)

• Possible Problems

  "[ERROR] ionic-app-scripts has unexpectedly closed (exit code 1)":

  If you encountered this bug, please delete the node_modules folder and then run 'npm install'

Setup Serenity

• Clone this project to your local repository
• Run 'npm install'

Setup Firebase Realtime Database

• Go to the Firebase Console to sign up for a free account: https://console.firebase.google.com/
• Setup and select your project.
• Navigate to the Realtime Database section.
• Click on the three vertical dots in the top-right corner of the database and select “Import JSON”.
• Upload the shared JSON file from 'db/export.json'
• Click on the “Rules” tab.
• Upload the shared JSON file from 'db/rules.json'
• Add credentials to 'app.firebaseconfig.ts'

Start Serenity

• Go into the project folder and type: ionic serve
• Follow the instructions in the CMD window and install all the dependencies

Test Serenity

• Once the build is completed, the Serenity application will run at https://localhost:8100, and it will pop up in your browser automatically

• For the first time, it will show some errors. To fix this, open any file that is showing on the screen. Then the project will rebuild and work properly.

• There are two ways to test Serenity on mobile

  In your browser, press f12, then your browser will go into mobile mode automatically

  Download Ionic DevApp on your mobile device, and follow https://ionicframework.com/docs/appflow/devapp/ to try Serenity on your device

Features Covered

• Login and Signup
• Change name and tolerance level
• Add friend
• Chat
• Show the tolerance score of each message
• Filter out any toxic messages based on tolerance level