Vylepšení dokumentace pro vývojáře
This commit is contained in:
		
							parent
							
								
									0e57acea2b
								
							
						
					
					
						commit
						3b429850a3
					
				
							
								
								
									
										20
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								README.md
									
									
									
									
									
								
							| @ -1,10 +1,22 @@ | |||||||
| # Luncher | # Luncher | ||||||
| Aplikace pro profesionální management obědů. | Aplikace pro profesionální management obědů. | ||||||
| 
 | 
 | ||||||
|  | Aplikace sestává ze tří (čtyř) modulů. | ||||||
|  | - food_api | ||||||
|  |   - Python scraper/parser pro zpracování obědových menu restaurací | ||||||
|  | - server | ||||||
|  |   - backend psaný v [node.js](https://nodejs.dev) | ||||||
|  | - client | ||||||
|  |   - frontend psaný v [React.js](https://react.dev) | ||||||
|  | - [nginx](https://nginx.org) | ||||||
|  |   - proxy pro snadné propojení Docker kontejnerů pod jednou URL | ||||||
|  | 
 | ||||||
| ## Spuštění pro vývoj | ## Spuštění pro vývoj | ||||||
| ### Závislosti | ### Závislosti | ||||||
|  | #### Food API | ||||||
| - [Python 3](https://www.python.org) | - [Python 3](https://www.python.org) | ||||||
| - [pip](https://pypi.org/project/pip) | - [pip](https://pypi.org/project/pip) | ||||||
|  | #### Klient/server | ||||||
| - [Node.js 18.x](https://nodejs.dev) | - [Node.js 18.x](https://nodejs.dev) | ||||||
| - [Yarn 1.22.x (Classic)](https://classic.yarnpkg.com) | - [Yarn 1.22.x (Classic)](https://classic.yarnpkg.com) | ||||||
| 
 | 
 | ||||||
| @ -14,6 +26,14 @@ Aplikace pro profesionální management obědů. | |||||||
| - Zkopírovat `server/.env.template` do `server/.env.development` a upravit dle potřeby | - Zkopírovat `server/.env.template` do `server/.env.development` a upravit dle potřeby | ||||||
| - Spustit `./run_dev.sh`. Na jiných platformách se lze inspirovat jeho obsahem, postup by měl být víceméně stejný. | - Spustit `./run_dev.sh`. Na jiných platformách se lze inspirovat jeho obsahem, postup by měl být víceméně stejný. | ||||||
| 
 | 
 | ||||||
|  | ## Sestavení a spuštění produkční verze v Docker | ||||||
|  | ### Závislosti | ||||||
|  | - [Docker](https://www.docker.com) | ||||||
|  | - [Docker Compose](https://docs.docker.com/compose) | ||||||
|  | 
 | ||||||
|  | ### Spuštění | ||||||
|  | - `docker compose up --build -d` | ||||||
|  | 
 | ||||||
| ## TODO | ## TODO | ||||||
| - [x] Umožnit smazání aktuální volby "popelnicí", místo nutnosti vybrat prázdnou položku v selectu | - [x] Umožnit smazání aktuální volby "popelnicí", místo nutnosti vybrat prázdnou položku v selectu | ||||||
| - [x] Přívětivější možnost odhlašování | - [x] Přívětivější možnost odhlašování | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user