Odstranění .env souborů, zavedení šablon

README.md

@@ -1,12 +1,18 @@
 # Luncher
+Aplikace pro profesionální management obědů.
 
-Zatím to nemá dokumentaci.
+## Spuštění pro vývoj
-Server je v adresáři /server, client v adresáři /client obojí lze spustit pomocí:
+### Závislosti
+- [Python 3](https://www.python.org)
+- [pip](https://pypi.org/project/pip)
+- [Node.js 18.x](https://nodejs.dev)
+- [Yarn 1.22.x (Classic)](https://classic.yarnpkg.com)
 
-### `yarn`
+### Spuštění na *nix platformách
-### `yarn start`
+- Nainstalovat závislosti viz předchozí bod
-
+- Zkopírovat `client/.env.template` do `client/.env.development` a upravit dle potřeby
-V *nix prostředích lze po instalaci základních závislostí (python, pip, venv) použít `./run_dev.sh`
+- 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ý.
 
 ## TODO
 - [x] Umožnit smazání aktuální volby "popelnicí", místo nutnosti vybrat prázdnou položku v selectu
@@ -26,11 +32,11 @@ V *nix prostředích lze po instalaci základních závislostí (python, pip, ve
 - [ ] Nasazení nové verze v Docker smaže veškerá data (protože data.json není venku)
 - [ ] Vylepšit dokumentaci projektu
   - [ ] Popsat Food API, nginx
-  - [ ] Popsat závislosti, co je nutné provést před vývojem a postup spuštění pro vývoj
+  - [x] Popsat závislosti, co je nutné provést před vývojem a postup spuštění pro vývoj
-  - [ ] Popsat dostupné env
+  - [x] Popsat dostupné env
 - [ ] Pizzy se samy budou při naklikání přidávat do košíku
   - [ ] Nutno nejprve vyřešit předávání PHPSESSIONID cookie na pizzachefie.cz pomocí fetch()
 - [ ] Přesunout autentizaci na server (JWT?)
-- [ ] Zavést .env.template a přidat .env do .gitignore
+- [x] Zavést .env.template a přidat .env do .gitignore
 - [ ] Zkrášlit dialog pro vyplnění čísla účtu, vypadá mizerně
 - [ ] Podpora pro notifikace v externích systémech (Gotify, Discord, MS Teams)

client/.env.production

@@ -1 +0,0 @@
-PUBLIC_URL=http://192.168.1.106:3005

client/.env.template

@@ -0,0 +1,3 @@
+# Veřejná URL, na které bude dostupný klient (typicky přes proxy).
+# Pro vývoj není potřeba, bude použita výchozí hodnota http://localhost:3001
+# PUBLIC_URL=http://example:3001

client/.gitignore

@@ -1 +1,2 @@
-build
+build
+.env.production

server/.env.development

@@ -1 +0,0 @@
-MOCK_DATA=true

server/.env.production

@@ -1 +0,0 @@
-FOOD_API_URL=http://nginx/api/food

server/.env.template

@@ -0,0 +1,8 @@
+# URL na kterém je dostupný Food API parser.
+# Pro vývoj není potřeba, bude použita výchozí hodnota http://localhost:3002
+# FOOD_API_URL=http://nginx/api/food
+
+# Zapne režim mockování jídelních lístků.
+# Vhodné pro vývoj o víkendech, svátcích a dalších dnech, pro které podniky nenabízejí obědové menu.
+# V tomto režimu vrací server vždy falešné datum (pracovní den) a Food API pevně nadefinovanou, smyšlenou nabídku jídel.
+# MOCK_DATA=true

server/.gitignore

@@ -1,3 +1,5 @@
 /node_modules
 /dist
-data.json
+data.json
+.env.production
+.env.development