Table of contents

  1. First run
  2. Updating dependencies
  3. Rebuilding Docker images
  4. Running database migrations

First run

After cloning the repository, you will need to do two things:

  1. Pull the required Docker images and install each container’s dependencies:
    make setup
  2. Bootstrap the development database:
    make bootstrap

You should now be able to start your local version of Offen using:

make up

To see if the application is working as intended visit http://localhost:8080 in your browser or use the application’s health check:

➜  ~ curl -X GET http://localhost:8080/healthz

To log into the development backend use the following credentials:

Password: development

You can stop the application using Ctrl+C, in case you want to tear down the current environment and delete the data stored in the local database you can use:

make down

Updating dependencies

In case the dependencies consumed by one of the containers have changed, you can run the following command to get an up-to-date version:

make update

Rebuilding Docker images

In case the Dockerfiles defining the development images have changes you will need to rebuild the local images using:

make dev-build

Running database migrations

If your local database schema is out of date and you need to apply the latest migrations, run

make migrate