tdpeuter/2025SELab2-project-Dwengo
tdpeuter/2025SELab2-project-Dwengo
1
Fork 0
Code Issues Releases 4 Packages 2 Wiki Activity

docs: Details in README

Browse source 
Signed-off-by: Tibo De Peuter <tibo.depeuter@ugent.be>
This commit is contained in:
Tibo De Peuter 2025-02-23 22:11:15 +01:00
parent 9bd7696c7b
commit 2030b97c21
Signed by: tdpeuter
GPG key ID: 38297DE43F75FFE2
9 changed files with 129 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -23,28 +23,31 @@ en lessen kunnen samenstellen hun leerlingen en hun vooruitgang kunnen opvolgen.
### 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.
1. Installeer Docker en Docker Compose op je systeem (zie [Docker](https://docs.docker.com/get-docker/) en [Docker Compose](https://docs.docker.com/compose/)).
2. Clone deze 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
docker compose up
```
### Handmatige installatie
Zie de submappen voor de installatie-instructies van de verschillende services.
Zie de submappen voor de installatie-instructies van de [frontend](./frontend/README.md) en [backend](./backend/README.md).
## Architectuur
```
hier overzichtsdiagram invoegen
```
![Architectuur](./docs/architecture/schema.png)
We maken gebruik van ... Meer informatie over deze ontwerpsbeslissingen kan je vinden in de [architectuurdocumentatie](./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](https://github.com/SELab-2/Dwengo-1/wiki/Design-keuzes).
## Bijdragen aan Dwengo-1