-
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:
- 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 the root folder with name UGent-6. This is the default name.
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
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.
Please make a .env file
application.properties en application-secrets.properties.
In de directory backend/web-bff/App/ voer je eerst npm install uit en dan npm run start om standaard te runnen of npm run dev om te auto reloaden bij aanpassingen.
Als je de mongodb storage wil testen, dan moet je zien dat er een mongodb community edition process op je computer aan het runnen is. Ikzelf heb in de mongosh shell de database en user zelf aangemaakt voor te verbinden met de server.
Standaard wordt er in de lokale uitvoering geen mongodb storage gebruikt, maar gewoon in memory storage.
Ook hier is een environment file nodig. Voorzie een file .env in de directory backend/web-bff/App/ met de nodige environment variables.
Execute npm run start in frontend/ directory.