docs: Beschrijf docker in installatie
This commit is contained in:
		
							parent
							
								
									7a657c9b86
								
							
						
					
					
						commit
						827b652b68
					
				
					 3 changed files with 31 additions and 14 deletions
				
			
		
							
								
								
									
										12
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										12
									
								
								README.md
									
										
									
									
									
								
							|  | @ -21,14 +21,17 @@ Alternatief kan je één van de volgende methodes gebruiken om de applicatie lok | |||
| 
 | ||||
| ### 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](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. | ||||
| 4. Voer `docker compose up` uit in de root van de repository. | ||||
| 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](https://github.com/SELab-2/Dwengo-1/wiki/Administrator:-Productie-omgeving#dwengo-1-configuratie). | ||||
| 6. De applicatie is nu beschikbaar op [`http://localhost/`](http://localhost/) en [`http://localhost/api`](http://localhost/api). | ||||
| 
 | ||||
| ```bash | ||||
| docker compose version | ||||
|  | @ -38,14 +41,13 @@ cp .env.example .env | |||
| # Pas .env aan | ||||
| nano .env | ||||
| cd .. | ||||
| docker compose up | ||||
| # Configureer de applicatie | ||||
| docker compose -f compose.staging.yml up --build | ||||
| ``` | ||||
| 
 | ||||
| ### Handmatige installatie | ||||
| ### Handmatige installatie en ontwikkeling | ||||
| 
 | ||||
| Zie de submappen voor de installatie-instructies van de [frontend](./frontend/README.md) | ||||
| en [backend](./backend/README.md). | ||||
| en [backend](./backend/README.md) en instructies voor het opzetten van een ontwikkelomgeving. | ||||
| 
 | ||||
| ## Architectuur | ||||
| 
 | ||||
|  |  | |||
|  | @ -4,23 +4,21 @@ | |||
| 
 | ||||
| ```shell | ||||
| npm install | ||||
| 
 | ||||
| # Start de nodige services voor ontwikkeling | ||||
| cd ../ # Ga naar de root van de repository | ||||
| docker compose up -d | ||||
| ``` | ||||
| 
 | ||||
| Setup the environment variables in a `.env` file in the root of the project. You can use the `.env.example` file as a template. | ||||
| Zet de omgevingsvariabelen in een `.env` bestand in de root van het project. | ||||
| Je kan het `.env.example` bestand als template gebruiken. | ||||
| 
 | ||||
| ### Development | ||||
| ### Ontwikkeling | ||||
| 
 | ||||
| ```shell | ||||
| npm run dev | ||||
| ``` | ||||
| 
 | ||||
| ### Production | ||||
| 
 | ||||
| ```shell | ||||
| npm run build | ||||
| npm run start | ||||
| ``` | ||||
| 
 | ||||
| ### Tests | ||||
| 
 | ||||
| Voer volgend commando uit om de unit tests uit te voeren: | ||||
|  | @ -29,6 +27,15 @@ Voer volgend commando uit om de unit tests uit te voeren: | |||
| npm run test:unit | ||||
| ``` | ||||
| 
 | ||||
| ### Productie | ||||
| 
 | ||||
| ```shell | ||||
| npm run build | ||||
| npm run start | ||||
| ``` | ||||
| 
 | ||||
| Zie ook de [installatiehandleiding](https://github.com/SELab-2/Dwengo-1/wiki/Administrator:-Productie-omgeving). | ||||
| 
 | ||||
| ## Keycloak configuratie | ||||
| 
 | ||||
| Tijdens development is het voldoende om gebruik te maken van de keycloak configuratie die automatisch ingeladen wordt. | ||||
|  |  | |||
|  | @ -19,7 +19,15 @@ See [Vite Configuration Reference](https://vite.dev/config/). | |||
| ## Project Setup | ||||
| 
 | ||||
| ```sh | ||||
| # Install dependencies | ||||
| npm install | ||||
| 
 | ||||
| # Start necessary services for development | ||||
| cd ../ # Go to the root of the repository | ||||
| docker compose up -d | ||||
| # Start the backend | ||||
| cd backend | ||||
| npm run dev # or npm run build && npm run start | ||||
| ``` | ||||
| 
 | ||||
| ### Compile and Hot-Reload for Development | ||||
|  |  | |||
		Reference in a new issue