develop

master

Team Project repo

Heroku Production (master) URI: https://nyu-mercury-prod.herokuapp.com/

Heroku Staging (develop) URI: https://nyu-mercury.herokuapp.com

Heroku Dashboard: https://dashboard.heroku.com/pipelines/35c0558f-127e-482b-8cdf-3f4d24464872

First time repo setup

1. From the root of the repo, run scripts/setup.sh. Activate your virtualenv first.
2. 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

N.B.: <something> means you need to change the something text within the angle brackets (and do not include the include brackets in your command).

1. Make a feature branch git checkout -b <new_branch_name>
2. Make your changes
3. Check you are using consistent style by running scripts/check.sh and make any recommended changes (such as running black to re-format).
4. Run your tests with python manage.py test and fix errors.
5. Use git add <filename> ... to add files you changed or more conveniently, git add -A.
6. Commit your changes with git commit -m "<message_of_what_this_commit_does>".
7. Push your branch to the origin fork with git push origin <new_branch_name> of the branch you made locally.
8. Visit our repo to create a Pull Request or use the link that the git command printed for you.
9. Add someone on the team as a review or share your URL to the Slack channel.

Fix issues

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

Run python manage.py runserver from the root of this Git repo

HOWTO Run tests locally

Run python manage.py test