Migrace na OpenAPI - TypeScript typy

README.md

@@ -1,7 +1,9 @@
 # Luncher
 Aplikace pro profesionální management obědů.
 
-Aplikace sestává ze dvou modulů + společných TypeScript definic (adresář `types`).
+Aplikace sestává ze tří modulů.
+- types
+  - OpenAPI definice společných typů, generované přes [openapi-ts](https://github.com/hey-api/openapi-ts)
 - server
   - backend psaný v [node.js](https://nodejs.dev)
 - client
@@ -10,19 +12,27 @@ Aplikace sestává ze dvou modulů + společných TypeScript definic (adresář
 ## Spuštění pro vývoj
 ### Závislosti
 #### Klient/server
-- [Node.js 22.x](https://nodejs.dev)
+- [Node.js 22.x (>= 22.11)](https://nodejs.dev)
 - [Yarn 1.22.x (Classic)](https://classic.yarnpkg.com)
 
 ### Spuštění na *nix platformách
 - Nainstalovat závislosti viz předchozí bod
 - 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ý.
+- Vygenerovat společné TypeScript typy
+  - `cd types && yarn install && yarn openapi-ts`
+- Server
+  - `cd server && yarn install && export NODE_ENV=development && yarn startReload`
+- Klient
+  - `cd client && yarn install && yarn start`
 
 ## 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`
+
 ### Spuštení s traefik
 - `docker compose -f compose-traefik.yml up --build -d`