ISCO

Prerequisite

• Docker > v19
• Docker Compose > v2.1
• Docker Sync 0.7.1

Development

Environment Setup

Expected that PORT 5432 and 3000 are not being used by other services.

Transactional email goes out over SMTP. Put the relay settings in a .env file in the project root:

EMAIL_HOST=""
EMAIL_PORT="587"
EMAIL_HOST_USER=""
EMAIL_HOST_PASSWORD=""
EMAIL_USE_TLS="true"
EMAIL_USE_SSL="false"

EMAIL_USE_TLS (STARTTLS, port 587) and EMAIL_USE_SSL (implicit SSL, port 465) are mutually exclusive; the defaults above match the common relay and apply when the variables are absent. Leave EMAIL_HOST empty during local development and mail sending simply fails and is logged.

Start

For initial run, you need to create a new docker volume.

docker volume create isco-docker-sync

./dc.sh up -d

The app should be running at: localhost:3000. Any endpoints with prefix

• ^/api/* is redirected to localhost:5000/api

Network Config:

• setupProxy.js
• mainnetwork container setup

Log

./dc.sh log --follow <container_name>

Available containers:

• backend
• frontend
• mainnetwork
• db
• pgadmin
• mailpit

Local Mail (Mailpit)

Emails sent by the backend in local development (user invitations, password resets, download readiness) are captured by Mailpit without needing external SMTP credentials:

• Web UI: http://localhost:8025
• SMTP Server: localhost:1025 (pre-configured for the backend)

./dc.sh stop

Teardown

docker-compose down -v
docker volume rm isco-docker-sync

Static Content Extraction

To extract the static content constants from the frontend application into a .xlsx spreadsheet, you can use the provided export script. This will run a script inside the Docker container to generate frontend/content-export.xlsx.

cd frontend
./export.sh

Production

export CI_COMMIT='local'
./ci/build.sh

Above command will generate two docker images with prefix eu.gcr.io/akvo-lumen/isco for backend and frontend

docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d

Network config: nginx