From f0c437de6f998dd906c4ac3554c907750d486b61 Mon Sep 17 00:00:00 2001 From: Tibo De Peuter Date: Thu, 20 Feb 2025 14:42:52 +0100 Subject: [PATCH] docs: Start README --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 34664b7e..46c426ed 100644 --- a/README.md +++ b/README.md @@ -1 +1,47 @@ -# Dwengo-1 \ No newline at end of file +

Dwengo-1

+ +

+ +OneDrive + +Figma + +Projectopgave +

+ + + +Dit is de monorepo voor [Dwengo-1](https://sel2-1.ugent.be), 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](https://docs.docker.com/get-docker/)). +2. Clone de repository. +3. Voer `docker-compose up` uit in de root van de repository. + +```bash +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 verschillende services. + +## Architectuur + +``` +hier overzichtsdiagram invoegen +``` + +We maken gebruik van ... Meer informatie over deze ontwerpsbeslissingen kan je vinden in de [architectuurdocumentatie](./architectuur).