README.rst

Open-source Happiness Packets

The Open-Source Happiness Packets project was created by Sasha Romijn and Mikey Ariel in March 2016. The idea came about while we were building our Healthy Minds in a Healthy Community presentation for Djangocon Europe 2016. One of the issues we wanted to address in the presentation was that many people are unaware of how loved, appreciated, or admired they are by their peers, since our culture seems to discourage positive feedback and amplify negative feedback. With this project, we wanted to provide a platform for people to send positive feedback, thanks, or just a kind word to their peers, with hope to make it easier and more acceptable for people to spread happiness, gratitude and appreciation in open-source communities.

The structure and format of the site is basic, and contributions are welcome!

To run this project or the tests, you need to set up a virtualenv, install the dev requirements and set the correct DJANGO_SETTINGS_MODULE, for example with:

virtualenv --no-site-packages --prompt='(happinesspackets)' virtualenv/
source virtualenv/bin/activate
pip install -r requirements/dev.txt
export DJANGO_SETTINGS_MODULE=happinesspackets.settings.dev
./t

The t command is a very short shell script that runs the tests with the correct settings and reports on coverage.

To run the integration tests:

./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting

This repository contains some documentation directly related to the code, built with Sphinx. To build the docs:

cd docs
make html
open _build/html/index.html