2025SELab2-project-Dwengo/README.md
Tibo De Peuter 2030b97c21
docs: Details in README
Signed-off-by: Tibo De Peuter <tibo.depeuter@ugent.be>
2025-02-24 19:40:23 +01:00

1.9 KiB

Dwengo-1

OneDrive Figma Projectopgave

  • Projectleider: Fransisco 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

Quick start

  1. Installeer Docker en Docker Compose op je systeem (zie Docker en Docker Compose).
  2. Clone deze repository.
  3. Voer docker compose up uit in de root van de repository.
docker compose version
git clone https://github.com/SELab-2/Dwengo-1.git
cd Dwengo-1
docker compose up

Handmatige installatie

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

Architectuur

Architectuur

De tech-stack bestaat uit:

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

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.