Skip to content

User guide for local development

Matthias Van Eyck edited this page May 23, 2024 · 17 revisions

Guide for development Ubuntu/linux

This is a guide giving step by step instructions to run this website locally for development pruposes.

The prerequisites:

  • a working java jdk version 17+
  • recent versions of node and npm (use a node version manager like nvm if you're having trouble with this step).
  • postgresql installation or docker and docker-compose

If ready clone the repository of github into a folder on your computer. For the sake of this guide i will refer to this folder as the root folder with name UGent-6. This is the default name.

Environments

Our website uses environment files in a couple different parts. To simplify the creating process of 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

Edit the file

Backend

In order to run the backend, first we have to setup a postgresql database. Either use a local installation or use the docker-compose file in the root directory, see the guide on running docker in this wiki.

If you have correct application.properties and application-secrets.properties files in the backend/app/src/main/resources/ folder, then you can start up the server with: ./gradlew bootRun

Express server

For this server a file called .env is required in the directory backend/web-bff/App/. See the provided template in .env.dev for details.

Execute

cd backend/web-bff/App
npm install
npm run dev

Frontend

Execute

cd frontend
npm install
npm run start
Clone this wiki locally