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.

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.

If using docker-compose

Please make a .env file

application.properties en application-secrets.properties.

Express server

Ook hier is een environment file nodig. Voorzie een file .env in de directory backend/web-bff/App/ met de nodige environment variables.

Execute

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

Frontend

Execute

cd frontend
npm install
npm run start
Clone this wiki locally