You are HERO is based on Django, a python web-framework. The Django documentation is detailed and we recommend the Tutorial.
Assuming you know the Basics (models, views, urls) we can start with the special characteristics of the You are HERO project.
The source code for this project is located in src/. Note that Django 1.4 comes with a new directory structure. You find the project related files in src/youarehero/.
By now there are the following custom apps:
We use south for database migrations.
Note
If you get an database related error after pulling the git repo, it may be necessary to migrate one of the custom apps. Try:
(env)$ src/managy.py migrate
In the deploy/ directory you find the requirements.txt (pip freeze <http://www.pip-installer.org/en/latest/requirements.html#freezing-requirements> output), which defines the python packages used in the projects virtualenv.
Apart from that you can push your tested commits to the git repo and they will be automatically deployed on the develoment server.
YAH uses the unittest module. Tests are located in
Django-coverage generates html with information about the test coverage of the project.
More documentation follows...
Beside Django and the project related apps there are other components used in this project: