-
Notifications
You must be signed in to change notification settings - Fork 0
User guide for local development
This is a guide giving step by step instructions to run this website locally for development pruposes.
The prerequisites:
- Java JDK version 17+
- Node and npm (we recommend you use a node version manager like nvm)
- Either a PostgreSQL installation, or a Docker installation
When that's ready, clone the GitHub repository into a folder on your computer.
Our website uses environment files in a couple different places. To simplify the process of creating these files, we have supplied templates and a generate script. Please fill in this template with the correct values and execute the script envBuilder.py
In order to run the backend, first we have to setup a PostgreSQL database. Here you can choose to either use a local installation of PostgreSQL or use the docker-compose file in the root directory of this repository.
To use Docker, make sure Docker is running on your device, and run following commands in a terminal in the root directory of this repository:
docker-compose --env-file=docker.env up -d --build
If you're not using Docker, make sure you have the correct application.properties and application-secrets.properties files in the backend/app/src/main/resources/ folder. After that, you can start the PostgreSQL server by running following commands in a terminal in the root directory of this repository:
cd backend/app/
./gradlew bootRun
For this server a file called .env is required in the directory backend/web-bff/App/. See the provided template in .env.dev for further details.
To start the Express server, run the following commands in a terminal in the root directory of this repository:
cd backend/web-bff/App/
npm install
npm run dev
To start the frontend, run the following commands in a terminal in the root directory of this repository:
cd frontend/
npm install
npm run start