From 3b429850a3be34963cddbfcf05a9eb7b0188e066 Mon Sep 17 00:00:00 2001 From: Martin Berka Date: Mon, 12 Jun 2023 21:54:42 +0200 Subject: [PATCH] =?UTF-8?q?Vylep=C5=A1en=C3=AD=20dokumentace=20pro=20v?= =?UTF-8?q?=C3=BDvoj=C3=A1=C5=99e?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 18d8586..52004b0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,22 @@ # Luncher 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 ### 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) @@ -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 - 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 - [x] Přívětivější možnost odhlašování