Mindful Extension

The internet has become a wonderful place to spread ideas and beliefs, and no one should be scared to share them online. The purpose of this extension is to make you more “mindful” of the things you say online, so more people can feel free to express themselves online.

Prerequisites

You will need:

Node.js (tested on v11.9.0)
npm (tested on v6.13.4)
Windows or Mac (tested on these platforms, should work on Linux)
Understanding of Browser Extensions and Architecture
Understanding of JavaScript
A passion of making the world a better place!

Installing (Local Development)

Clone Repo (if getting code from Github - else, move on to next step)

git clone https://github.com/MitchellMarkGeorge/Mindful

Install Dependencies

npm install

Run dev build (files will be watched and rebuilt on file changes)

npm run build

To create minified dist build, run:

npm run dist-build

Package app for Chrome Distribution (a chrome.zip file will be made):

npm run chrome-dist

The img folder is for promotional images

Running the tests

To test the code, run:

npm run standard

Built With

VadarSentiment - Used for sentiment analysis (emojis)
- Current version
Tensorflow.js Toxicity Model - Used for advanced text analysis
- Current version
Load Awsome Spinner - Used to show green loader in extension. (included in source code)

Versioning

We use SemVer for versioning.

Authors

Mitchell Mark-George - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the AGPL-3.0-only License - see the LICENSE.txt file for details