BillBrower / albatross-api

Overview of our development process

I've written up a brief overview of our development process here. Read that first before doing anything else.

Setup Your Development Environment

1. Install postgres on your machine.
2. Clone this repo.
3. Open terminal and navigate to your local copy of this repo.
4. Get environment_variables.sh from Bill and put it in your repo root.
5. Run these commands

cd .. && python3 -m venv /path/to/case-status-api/repo
cd /path/to/case-status-api/repo
printf '\nsource /path/to/albatross-api/environment_variables.sh' >> ./bin/activate
source ./bin/activate && cd ..
pip install -r requirements.txt

Developing and Testing

1. If you haven't used Django before:

   a. Skim through the official Django overview and the official Django tutorial.

   b. Read this stackoverflow question and its accepted answer.

   c. Watch at least the first 20 minutes of this talk and if you're really interested watch this one.

   d. Read the official Django Rest Framework tutorial

   e. django-tagging Is a good example Django app.

   f. This is a good Django Rest Framework cheatsheet.

   Django doesn't neccessarily have a whole lot of magic but it is pretty opinonated, so it is important to understand the design philosophy behind it before you start programming with it.

2. Run source ./bin/activate before you start developing or testing.

3. To run the API locally cd into the albatross directory and use python ./manage.py runserver

4. To run the tests locally cd into the albatross directory and use python ./manage.py test

Notes

If you get environment_variables.sh:6: = not found when running source ./bin/activate, change all instances of == to =.