Get started with INESData Map

This is a guide for launching the INESData Map application using Docker in a local environment.

This project contains git submodules for the Map editor backend and the Map editor frontend repositories.

To clone this repository and initialize and update each submodule, use the following command:

git clone --recurse-submodules https://github.com/INESData/inesdata-map-getstarted

If you already cloned the project and forgot --recurse-submodules, you can by running the following command:

git submodule update --init

To update the submodules to the latest commit, run the following command:

git submodule update --remote

Prerequisites

• Install Docker and Docker Compose
• The following ports must not be occupied: 80, 8080, 5432

Services

This application consists of the following services:

• Map editor frontend (port 80)
• Map editor backend (port 8080)
• PostgreSQL database (port 5432)

Configuration

The configuration of the application is done through different environment variables. The environment variables are defined in the docker-compose.yaml file.

Starting the application

To start the services, the following command must be executed from a command line window:

docker compose -p inesdata-map up --build -d

Verifying the installation

To check the status of the containers, the following command must be executed from a command line window:

docker ps

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
d8b44bac3798 inesdata-map/mapper-backend "./docker-entrypoint…" 25 minutes ago Up About a minute 0.0.0.0:8080->8080/tcp, :::8080->8080/tcp inesdata-map-map-editor-backend-1
19cadc44820e inesdata-map/mapper-frontend "sh -c ${NGINX_HOME}…" 25 minutes ago Up About a minute 0.0.0.0:80->80/tcp, :::80->80/tcp inesdata-map-map-editor-frontend-1
d2b956be18b8 postgres:16.4 "docker-entrypoint.s…" 25 minutes ago Up About a minute (healthy) 0.0.0.0:5432->5432/tcp, :::5432->5432/tcp inesdata-map-db-postgres-1

This will indicate that the three containers have started successfully. To access the application, open a web browser and enter the URL http://localhost:80.

Stopping the application

To stop the services, the following command must be executed from a command line window:

docker compose -p inesdata-map stop