diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 8a6629f0..05b96755 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -24,6 +24,14 @@ Een duidelijke, beknopte beschrijving van wat je verwacht dat er gebeurt. Indien van toepassing, voeg een screenshot toe die het probleem duidelijk maakt. **Extra context** -Voeg extra context over het probleem toe. Was je ergens bijzonder mee bezig of naar op zoek? +Was je ergens bijzonder mee bezig of naar op zoek? Welke documentatie of links heb je (al) geraadpleegd? -- [ ] Ik heb aan deze issue het juiste label toegekend, afhankelijk van frontend, backend, ... + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index b99513ab..dd1ed988 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -6,7 +6,7 @@ labels: enhancement assignees: '' --- -**Is your feature request related to a problem? Please describe.** +**Is jouw feature request gerelateerd tot een probleem? Beschrijf.** Een duidelijke, beknopte beschrijving van het probleem. Wat mist er? Wat kan beter? **Beschrijf de oplossing die je zou willen** @@ -15,4 +15,11 @@ Een duidelijke, beknopte beschrijving van wat je zou willen dat er gebeurt. **Extra context** Extra context of screenshots bij de feature. -- [ ] Ik heb aan deze issue het juiste label toegekend, afhankelijk van frontend, backend, ... + diff --git a/README.md b/README.md index fcc4d3ba..a912a9ce 100644 --- a/README.md +++ b/README.md @@ -9,29 +9,26 @@ 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 -Om de applicatie in te stellen voor een productieomgeving, volg de [installatiehandleiding](https://github.com/SELab-2/Dwengo-1/wiki/Administrator:-Productie-omgeving). +Om de applicatie in te stellen voor een productieomgeving, volg +de [installatiehandleiding](https://github.com/SELab-2/Dwengo-1/wiki/Administrator:-Productie-omgeving). 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](https://docs.docker.com/get-docker/) en [Docker Compose](https://docs.docker.com/compose/)). +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. In de backend, kopieer `.env.example` (of `.env.development.example`) naar `.env` en pas de variabelen aan waar nodig. +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](https://github.com/SELab-2/Dwengo-1/wiki/Administrator:-Productie-omgeving#dwengo-1-configuratie). +5. Optioneel: Configureer de applicatie aan de hand van + de [configuratiehandleiding](https://github.com/SELab-2/Dwengo-1/wiki/Administrator:-Productie-omgeving#dwengo-1-configuratie). ```bash docker compose version @@ -47,7 +44,8 @@ docker compose up ### Handmatige installatie -Zie de submappen voor de installatie-instructies van de [frontend](./frontend/README.md) en [backend](./backend/README.md). +Zie de submappen voor de installatie-instructies van de [frontend](./frontend/README.md) +en [backend](./backend/README.md). ## Architectuur @@ -59,8 +57,23 @@ De tech-stack bestaat uit: - **Backend**: TypeScript + Node.js + Express.js + TypeORM + PostgreSQL - **Identity provider**: Keycloak -Voor meer informatie over de keuze van deze tech-stack, zie [designkeuzes](https://github.com/SELab-2/Dwengo-1/wiki/Developer:-Design-keuzes). +Voor meer informatie over de keuze van deze tech-stack, +zie [designkeuzes](https://github.com/SELab-2/Dwengo-1/wiki/Developer:-Design-keuzes). ## Bijdragen aan Dwengo-1 Zie [CONTRIBUTING.md](./CONTRIBUTING.md) voor meer informatie over hoe je kan bijdragen aan Dwengo-1. + +Deze rocksterren hebben bijgedragen aan Dwengo-1: + +| Naam | Functie | +| ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | +| [
Adriaan Jacquet](https://github.com/WhisperinCheetah) | Backend Lead | +| [
Francisco Gabriel Van Langenhove](https://github.com/Gabriellvl) | Team Lead | +| [
Gerald Schmittinger](https://github.com/geraldschmittinger) | Database Administrator | +| [
Joyelle Ndagijimana](https://github.com/joyelle436) | Frontend Lead | +| [
Laure Jablonski](https://github.com/laurejablonski) | Documentatie- en Test Lead | +| [
Tibo De Peuter](https://github.com/tdpeuter) | Technische Lead | +| [
Timo De Meyst](https://github.com/kloep1) | System Administrator | + +En in de toekomst misschien jij ook?