docs: Start README
This commit is contained in:
		
							parent
							
								
									a0317090c7
								
							
						
					
					
						commit
						f0c437de6f
					
				
					 1 changed files with 47 additions and 1 deletions
				
			
		
							
								
								
									
										48
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										48
									
								
								README.md
									
										
									
									
									
								
							|  | @ -1 +1,47 @@ | ||||||
| # Dwengo-1 | <h1 align="center">Dwengo-1</h1> | ||||||
|  | 
 | ||||||
|  | <p align="center"> | ||||||
|  | <span><a href="https://ugentbe-my.sharepoint.com/:f:/r/personal/bart_mesuere_ugent_be/Documents/Onderwijs/SELab2/2024-2025/mappen%20studenten/groep1" alt="OneDrive"> | ||||||
|  | OneDrive</a></span> | ||||||
|  | <span><a href="https://www.figma.com/files/project/339220191" alt="Figma sjabloon"> | ||||||
|  | Figma</a></span> | ||||||
|  | <span><a href="../Dwengo-opgave" alt="projectopgave"> | ||||||
|  | Projectopgave</a></span> | ||||||
|  | </p> | ||||||
|  | 
 | ||||||
|  | <ul align="center" style="list-style-type: none"> | ||||||
|  | <li>Projectleider: Fransisco Van Langenhove (@Gabriellvl)</li> | ||||||
|  | <li>Technische lead: Tibo De Peuter (@tdpeuter)</li> | ||||||
|  | <li>Systeembeheerder: Timo De Meyst (@kloep1)</li> | ||||||
|  | <li>Customer relations officer: Adriaan Jacquet (@WhisperinCheetah)</li> | ||||||
|  | </ul> | ||||||
|  | 
 | ||||||
|  | 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). | ||||||
|  |  | ||||||
		Reference in a new issue