Skip to content

SELab-2/Dwengo-1

Repository files navigation

Dwengo-1

OneDrive Figma Projectopgave

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

Om de applicatie lokaal te draaien als kant-en-klare Docker-containers:

  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 naar .env en pas de variabelen aan waar nodig.
  4. Voer docker compose -f compose.staging.yml up --build uit in de root van de repository.
  5. Optioneel: Configureer de applicatie aan de hand van de configuratiehandleiding.
  6. De applicatie is nu beschikbaar op http://localhost/ en http://localhost/api.
docker compose version
git clone https://github.com/SELab-2/Dwengo-1.git
docker compose -f compose.staging.yml up --build
# Gebruikt backend/.env.staging

Handmatige installatie en ontwikkeling

Zie de submappen voor de installatie-instructies van de frontend en backend en instructies voor het opzetten van een ontwikkelomgeving.

Architectuur

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.

Testen

Voer volgende commando's uit om de <frontend/backend> te testen:

npm run test:unit

Bijdragen aan Dwengo-1

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

Deze rocksterren hebben bijgedragen aan Dwengo-1:

Naam Functie

Adriaan Jacquet
Backend Lead

Francisco Gabriel Van Langenhove
Team Lead

Gerald Schmittinger
Database Administrator

Joyelle Ndagijimana
Frontend Lead

Laure Jablonski
Documentatie- en Test Lead

Tibo De Peuter
Technische Lead

Timo De Meyst
System Administrator

En in de toekomst misschien jij ook?

About

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 10

Languages