Kindness First Penguin is a chrome extension that takes in users' texts. Kindness First Penguin analyzes the texts and changes its states based on sentiment polarity of the texts. Users can also feed Kindness First Penguin, and Kindness First Penguin's mood will improve. The visual image of Kindness First Penguin raises awareness of users' mood states, and it encourages users to talk more constructively rather than resorting to toxic behaviors on the Internet. Most importantly, Kindness First Penguin helps people practice positive self-talk, check-in with their feelings, be grateful, and even perform small acts of kindness.
Positive talk and a more optimistic outlook can have health benefits such as:
- greater satisfaction in life
- reduced stress
- better physical well-being
- increased vitality
We hope Kindness First Penguin gives you positive affirmations and identify negative talks. Surround yourself with positive people!
Below is the step-by-step of how you can install and set up the extension:
-
Clone the repo
git clone https://github.com/eamspoker/KindnessFirstPenguin-Public
-
Go to Chrome extensions and turn on developer mode
-
Press Load unpacked and upload .js and .html files
-
Rename example_manifest.json to manifest .json
-
Generate a client ID for OAuth and add it into the manifest.json
-
Create Python virtual environment
python3 -m venv env
-
Activate virtual environment
source env/bin/activate
-
Install python environments
pip3 install -r requirements.txt
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/<FeatureName>
) - Commit your Changes (
git commit -m 'Add some <FeatureName>'
) - Push to the Branch (
git push origin feature/<FeatureName>
) - Open a Pull Request
Emily Amspoker - eamspoke@andrew.cmu.edu
Emily Guo - emilyguo@andrew.cmu.edu
Ellia Yang - elliay@andrew.cmu.edu
Esther Ahn - yejua@andrew.cmu.edu
Project Link: https://github.com/eamspoker/KindnessFirstPenguin-Public