Milestones and Project Board

API specification

Frontend

To run the frontend in developer mode (with hot-reload), simply run the command

yarn start

If you wish to use storybook (to see the components in isolation), first install it:

npx -p @storybook/cli

And then run it by entering

yarn storybook

Other than that, it's just a create-react-app, so the normal yarn build etc. works!

To test the application, we have three different commands;

• yarn test -- Runs the component and reducer tests. Does not require a backend running.
• yarn test:api -- Only run the backend integration tests. Requires a running instance of the backend.
• yarn test:all -- Runs everything. Requires a running instance of the backend.

Backend

Setup

With docker

• NOTE: Docker commands have to be run as root on linux, unless you are a member of the docker group

A Makefile is provided with aliases for useful commands:

# Create the server. Has to be run before any other commands make build

# Start the server make

# Start and stop the server in the background make up make down

## The following require that the server is running

# Handle migrations make makemigrations make migrate

# Run unit-tests make test

# Update pip requirements (after changing requirements.txt) make update

# Create a new app make startapp APP=

When the docker container is running any changes to the source files are synced to the container, and django reloads them automatically. Therefore the server doesn't have to be restarted after a change.

Migrations created in the container are synced back to the source tree, and should be added to git.

Without docker

The server can be run as a normal django server, but then you have to install a database manually. The django settings can be overriden by creating the file backend/local_settings.py and overriding any variables set in settings.py.

Happy hacking! :tada: