Přidání Andělovin do README.md

README.md

@@ -1,12 +1,38 @@
 # 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í:
+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
 
-### `yarn`
-### `yarn start`
+## Spuštění pro vývoj
+### Závislosti
+#### Food API
+- [Python 3](https://www.python.org)
+- [pip](https://pypi.org/project/pip)
+#### Klient/server
+- [Node.js 18.x](https://nodejs.dev)
+- [Yarn 1.22.x (Classic)](https://classic.yarnpkg.com)
 
-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ý.
+
+## 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
 - [x] Umožnit smazání aktuální volby "popelnicí", místo nutnosti vybrat prázdnou položku v selectu
@@ -15,22 +41,23 @@ V *nix prostředích lze po instalaci základních závislostí (python, pip, ve
 - [x] Vyndat URL na Food API do .env
 - [x] Neselhat při nedostupnosti nebo chybě z Food API
 - [x] Dokončit docker-compose pro kompletní funkčnost
-- [x] Implementovat základ pro pizza day
+- [x] Implementovat Pizza day
   - [x] Umožnit uzamčení objednávek zakladatelem
   - [x] Možnost uložení čísla účtu
   - [ ] Automatické generování a zobrazení QR kódů
     - [ ] https://qr-platba.cz/pro-vyvojare/restful-api/
   - [ ] Zobrazovat celkovou cenu objednávky pod tabulkou objednávek
-- [ ] Zobrazit upozornění před smazáním/zamknutím/odemknutím pizza day
+  - [ ] Zobrazit upozornění před smazáním/zamknutím/odemknutím pizza day
+  - [ ] Umožnit přidat k objednávce poznámku (např. "bez oliv")
 - [ ] Předvyplnění poslední vybrané hodnoty občas nefunguje, viz komentář
 - [ ] 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)

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

client/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:alpine AS builder
+FROM node:18-alpine3.18 AS builder
 
 COPY package.json .
 COPY yarn.lock .
@@ -12,7 +12,7 @@ COPY ./public ./public
 
 RUN yarn build
 
-FROM node:alpine
+FROM node:18-alpine3.18
 ENV NODE_ENV production
 
 WORKDIR /app

client/src/App.tsx

@@ -125,29 +125,29 @@ function App() {
     }
   }
 
-  const addToCart = async () => {
-    // TODO aktuálně nefunkční - nedokážeme poslat PHPSESSIONID cookie
-    // if (data?.pizzaDay?.orders) {
-    //   for (const order of data?.pizzaDay?.orders) {
-    //     for (const pizzaOrder of order.pizzaList) {
-    //       const url = 'https://www.pizzachefie.cz/pridat.html';
-    //       const payload = new URLSearchParams();
-    //       payload.append('varId', pizzaOrder.varId.toString());
-    //       await fetch(url, {
-    //         method: "POST",
-    //         mode: "no-cors",
-    //         cache: "no-cache",
-    //         credentials: "same-origin",
-    //         headers: {
-    //           'Content-Type': 'application/x-www-form-urlencoded',
-    //         },
-    //         body: payload,
-    //       })
-    //     }
-    //   }
-    //   // TODO otevřít košík v nové záložce
-    // }
-  }
+  // const addToCart = async () => {
+  // TODO aktuálně nefunkční - nedokážeme poslat PHPSESSIONID cookie
+  // if (data?.pizzaDay?.orders) {
+  //   for (const order of data?.pizzaDay?.orders) {
+  //     for (const pizzaOrder of order.pizzaList) {
+  //       const url = 'https://www.pizzachefie.cz/pridat.html';
+  //       const payload = new URLSearchParams();
+  //       payload.append('varId', pizzaOrder.varId.toString());
+  //       await fetch(url, {
+  //         method: "POST",
+  //         mode: "no-cors",
+  //         cache: "no-cache",
+  //         credentials: "same-origin",
+  //         headers: {
+  //           'Content-Type': 'application/x-www-form-urlencoded',
+  //         },
+  //         body: payload,
+  //       })
+  //     }
+  //   }
+  //   // TODO otevřít košík v nové záložce
+  // }
+  // }
 
   const renderFoodTable = (name, food) => {
     return <Col md={12} lg={4}>
@@ -174,7 +174,7 @@ function App() {
     return <div>Načítám data...</div>
   }
 
-  const noOrders = data?.pizzaDay?.orders?.length == 0;
+  const noOrders = data?.pizzaDay?.orders?.length === 0;
 
   return (
     <>
@@ -184,7 +184,9 @@ function App() {
           <Alert variant={'primary'}>
             Poslední změny:
             <ul>
-              <li>Přechody mezi stavy Pizza Day: Vytvořeno -&gt; Uzamčeno -&gt; Objednáno -&gt; Doručeno</li>
+              <li>Podpora Gotify</li>
+              <li>Vylepšení dokumentace pro vývojáře</li>
+              <li>Potíže usnout i v pozdních nočních hodinách</li>
             </ul>
           </Alert>
           <h1 className='title'>Dnes je {data.date}</h1>

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

server/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:alpine
+FROM node:18-alpine3.18
 
 ENV LANG cs_CZ.UTF-8  
 

server/src/chefie.ts

@@ -22,9 +22,6 @@ type Pizza = {
 const baseUrl = 'https://www.pizzachefie.cz';
 const pizzyUrl = `${baseUrl}/pizzy.html?pobocka=plzen`;
 
-// URL na Food API - získání jídelních lístků restaurací
-const foodUrl = process.env.FOOD_API_URL || 'http://localhost:3002';
-
 const buildPizzaUrl = (pizzaUrl: string) => {
     return `${baseUrl}/${pizzaUrl}`;
 }