2025SELab2-project-Dwengo/README.md

Dwengo-1

OneDrive Figma Projectopgave

• Projectleider: Fransisco Gabriel Van Langenhove (@Gabriellvl)
• Technische lead: Tibo De Peuter (@tdpeuter)
• Systeembeheerder: Timo De Meyst (@kloep1)
• Customer relations officer: Adriaan Jacquet (@WhisperinCheetah)

Dit is de monorepo voor Dwengo-1, een interactief leerplatform waar leerkrachten opdrachten en lessen kunnen samenstellen hun leerlingen en hun vooruitgang kunnen opvolgen.

Installatie

Om de applicatie in te stellen voor een productieomgeving, volg de installatiehandleiding.

Alternatief kan je één van de volgende methodes gebruiken om de applicatie lokaal te draaien.

Quick start

1. Installeer Docker en Docker Compose op je systeem (zie Docker en Docker Compose).
2. Clone deze repository.
3. In de backend, kopieer .env.example (of .env.development.example) naar .env en pas de variabelen aan waar nodig.
4. Voer docker compose up uit in de root van de repository.
5. Optioneel: Configureer de applicatie aan de hand van de configuratiehandleiding.

docker compose version
git clone https://github.com/SELab-2/Dwengo-1.git
cd Dwengo-1/backend
cp .env.example .env
# Pas .env aan
nano .env
cd ..
docker compose up
# Configureer de applicatie

Handmatige installatie

Zie de submappen voor de installatie-instructies van de frontend en backend.

Architectuur

De tech-stack bestaat uit:

• Frontend: TypeScript + Vue.js + Vuetify
• Backend: TypeScript + Node.js + Express.js + TypeORM + PostgreSQL
• Identity provider: Keycloak

Voor meer informatie over de keuze van deze tech-stack, zie designkeuzes.

Bijdragen aan Dwengo-1

Zie CONTRIBUTING.md voor meer informatie over hoe je kan bijdragen aan Dwengo-1.