diff --git a/README.md b/README.md index 8105326..18d8586 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ # Luncher +Aplikace pro profesionální management obědů. -Zatím to nemá dokumentaci. -Server je v adresáři /server, client v adresáři /client obojí lze spustit pomocí: +## Spuštění pro vývoj +### 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` -### `yarn start` - -V *nix prostředích lze po instalaci základních závislostí (python, pip, venv) použít `./run_dev.sh` +### Spuštění na *nix platformách +- Nainstalovat závislosti viz předchozí bod +- Zkopírovat `client/.env.template` do `client/.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ý. ## 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 - - [ ] Popsat dostupné env + - [x] Popsat závislosti, co je nutné provést před vývojem a postup spuštění pro vývoj + - [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) \ No newline at end of file diff --git a/client/.env.production b/client/.env.production deleted file mode 100644 index ccaad5e..0000000 --- a/client/.env.production +++ /dev/null @@ -1 +0,0 @@ -PUBLIC_URL=http://192.168.1.106:3005 \ No newline at end of file diff --git a/client/.env.template b/client/.env.template new file mode 100644 index 0000000..7b6a1c1 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/client/.gitignore b/client/.gitignore index c795b05..2d26987 100644 --- a/client/.gitignore +++ b/client/.gitignore @@ -1 +1,2 @@ -build \ No newline at end of file +build +.env.production \ No newline at end of file diff --git a/server/.env.development b/server/.env.development deleted file mode 100644 index 2c143ae..0000000 --- a/server/.env.development +++ /dev/null @@ -1 +0,0 @@ -MOCK_DATA=true \ No newline at end of file diff --git a/server/.env.production b/server/.env.production deleted file mode 100644 index ac64ac4..0000000 --- a/server/.env.production +++ /dev/null @@ -1 +0,0 @@ -FOOD_API_URL=http://nginx/api/food \ No newline at end of file diff --git a/server/.env.template b/server/.env.template new file mode 100644 index 0000000..82489f9 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/server/.gitignore b/server/.gitignore index 7ef8200..2ff3785 100644 --- a/server/.gitignore +++ b/server/.gitignore @@ -1,3 +1,5 @@ /node_modules /dist -data.json \ No newline at end of file +data.json +.env.production +.env.development \ No newline at end of file