Open-source tracker for menstrual periods. Check out the live app: https://eggtimer.herokuapp.com/

Note: the front end for this app is being ported to Ionic (see https://github.com/jessamynsmith/eggtimer-ui)

Fork the project on github and git clone your fork, e.g.:

git clone https://github.com/<username>/eggtimer-server.git

Create a virtualenv using Python 3 and install dependencies. NOTE! You must change 'path/to/python3' to be the actual path to python3 on your system.

mkvirtualenv eggtimer --python=/path/to/python3
pip install -r requirements/development.txt

Edit development settings as needed to match your environment (check DATABASES in particular), and ensure those settings will be used automatically:

export DJANGO_SETTINGS_MODULE=eggtimer.settings.development

Set up db:

python manage.py syncdb
python manage.py migrate

Run tests and view coverage:

coverage run manage.py test
coverage report -m

Check code style:

flake8

Run server:

python manage.py runserver

The javascript linter and tests require you to install node, then:

npm install -g jshint mocha blanket moment

Set up your environment to know about node. NOTE! You must change 'path/to/node_modules' to be the actual path to node modules on your system.

export NODE_PATH=/path/to/node_modules/

Lint JavaScript:

jshint */static/js

Run JavaScript tests:

mocha -R html-cov */tests/static/js/* > ~/eggtimer_javascript_coverage.html

This project is already set up for continuous integration and deployment using circleci, coveralls, and Heroku.

Make a new Heroku app, and add the following addons:

Heroku Postgres
Mailgun
New Relic APM
Papertrail
Heroku Scheduler

Enable the project on coveralls.io, and copy the repo token

Enable the project on circleci.io, and under Project Settings -> Environment variables, add:

COVERALLS_REPO_TOKEN <value_copied_from_coveralls>

On circleci.io, under Project Settings -> Heroku Deployment, follow the steps to enable Heroku builds. At this point, you may need to cancel any currently running builds, then run a new build.

Once your app is deployed successfully, you can add the Scheduler task on Heroku:

python manage.py notify_upcoming_period --settings=eggtimer.settings.production

Thank you to: Emily Strickland (github.com/emilyst) for the name