backend

Environment Variables

DATA_DIR=<dir> # Directory to store data (sqlite db and uploads)
FRONTEND_URL=<url to frontend>
BACKEND_URL=<url of the application>
DEFAULT_REDIRECT=<url to redirect to upon login>
TEST_MODE=true # used for running the tests via bruno

Development

Important

To push any changes to this repo, all your commits must be signed. If you are getting errors related to that, please ensure that you have enabled code signing in git and have uploaded your public key to GitHub.

API docs

API documentation is available at <url>/swagger/index.html, for local development typically at http://localhost:8080/swagger/index.html

Starting for backend development

./launch.sh

This will run it in development mode with a sqlite backend. Setting env vars will override the config file settings

Running tests

Run the provided script in the testing directory after spinning up the backend using

./launch.sh testing

This will start the backend in testing mode (i.e. with some extra routes to facilitate the tests, such as allowing userID switching for Access Control tests)