System Setup :
./install_os_dependencies.sh install
- Install Anaconda - https://www.continuum.io/downloads#_unix
- Create a virtual env
conda create -n remind_me python=3.4.3
and activate it usingsource activate remind_me
- Install the requirements with
pip install -r requirements.txt
- Install MySql and create a table
reminders
- Add
export DJANGO_SETTINGS_MODULE=reminder.settings.local
to .bashrc - Add
export DJANGO_SECRET_KEY='YOUR-SECRET-KEY-HERE'
- Add
export DATABASE_URL=mysql://<USER>:<PASSWORD>@<HOST>:<PORT>/reminders
- Install Redis and start
Setup Hooks :
- From the project root execute :
./bootstrap_git_hooks.sh
- (the above command creates a sym link to your pre_commit hook)
- if you wish to bypass the commit hook then use
git commit -n
API Documentation :
Test Coverage :
- Run tests using:
coverage run manage.py test --settings=reminder.settings.test
- View coverage -
coverage report