First time repo setup
- From the root of the repo, run
scripts/setup.sh. Activate your virtualenv first.
- To run the server, run
python manage.py runserver.
You should now be able to view the site at http://127.0.0.1:8000/
HOWTO Contribute to this repo
<something> means you need to change the
something text within the angle brackets (and do not include the include brackets in your command).
- Make a feature branch
git checkout -b <new_branch_name>
- Make your changes
- Check you are using consistent style by running
scripts/check.shand make any recommended changes (such as running black to re-format).
- Run your tests with
python manage.py testand fix errors.
git add <filename> ...to add files you changed or more conveniently,
git add -A.
- Commit your changes with
git commit -m "<message_of_what_this_commit_does>".
- Push your branch to the origin fork with
git push origin <new_branch_name>of the branch you made locally.
- Visit our repo to create a Pull Request or use the link that the
gitcommand printed for you.
- Add someone on the team as a review or share your URL to the Slack channel.
Running into issues with modules not find? Did
requirements.txt update from your last
git pull command? Run
pip install -r requirements.txt to install missing modules.
Are you missing staticfiles when trying to run or test locally? Run
python manage.py collectstatic to regenerate them.
HOWTO Run the app locally
python manage.py runserver from the root of this Git repo
HOWTO Run tests locally
python manage.py test