claeusdev/app-digitaal-loket

Digitaal loket application

Digitaal loket

APIs and Digitaal Loket application on top of the Mandaat model and application profile as defined on:

• http://data.vlaanderen.be/ns/mandaat
• http://data.vlaanderen.be/doc/applicatieprofiel/mandatendatabank

What's included?

This repository harvest two setups. The base of these setups resides in the standard docker-compose.yml.

• docker-compose.yml This provides you with the backend components. There is a frontend application included which you can publish using a separate proxy (we tend to put a letsencrypt proxy in front).
• docker-compose.dev.yml Provides changes for a good frontend development setup.
  • publishes the backend services on port 80 directly, so you can run ember serve --proxy http://localhost when developing the frontend apps natively.
  • publishes the database instance on port 8890 so you can easily see what content is stored in the base triplestore
  • provides a mock-login backend service so you don't need the ACM/IDM integration.

Running and maintaining

General information on running and maintaining an installation

Running your setup

Running the regular setup

docker-compose up

The stack is built starting from mu-project.

OpenAPI documentation can be generated using cl-resources-openapi-generator.

Running the dev setup

First install git-lfs (see https://github.com/git-lfs/git-lfs/wiki/Installation)

Execute the following:

  # Make sure git-lfs is enabled after installation
  git lfs install

  # Clone this repository
  git clone https://github.com/lblod/app-digitaal-loket.git

  # Move into the directory
  cd app-digitaal-loket

  # Start the system
  docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

Wait for everything to boot to ensure clean caches. You may choose to monitor the migrations service in a separate terminal to and wait for the overview of all migrations to appear: docker-compose logs -f --tail=100 migrations.

Once the migrations have ran, you can start developing your application by connecting the ember frontend application to this backend. See https://github.com/lblod/frontend-loket for more information on development with the ember application.

Upgrading your setup

Once installed, you may desire to upgrade your current setup to follow development of the main stack. The following example describes how to do this easily for both the demo setup, as well as for the dev setup.

Upgrading the dev setup

For the dev setup, we assume you'll pull more often and thus will most likely clear the database separately:

  # Bring the application down
  docker-compose -f docker-compose.yml -f docker-compose.dev.yml down
  # Pull in the changes
  git pull origin master
  # Launch the stack
  docker-compose -f docker-compose.yml -f docker-compose.demo.yml up

As with the initial setup, we wait for everything to boot to ensure clean caches. You may choose to monitor the migrations service in a separate terminal to and wait for the overview of all migrations to appear: docker-compose logs -f --tail=100 migrations.

Once the migrations have ran, you can go on with your current setup.

Cleaning the database

At some times you may want te clean the database and make sure it's in a pristine state.

  # Bring down our current setup
  docker-compose -f docker-compose.yml -f docker-compose.dev.yml down
  # Keep only required database files
  rm -Rf data/db
  git checkout data/db
  # Bring the stack back up
  docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

Make sure to wait for the migrations to run.