README

Author: ketiv17

README.md

@@ -0,0 +1,40 @@
+# Tour de App - SvelteKit + Express boiler plate
+
+Šablona pro vývoj aplikace v soutěži Tour de App společně s frontendovou částí frameworku [SvelteKit](https://svelte.dev/docs/kit), a backendovou částí v [Express](https://expressjs.com/).
+
+## Produkční setup
+
+Jak se aplikace spustí na tourde.cloud je definováno v souboru `tourdeapp.yaml` v kořenovém adresáři tohoto repozitáře. V tomto boiler plate se spouští služby:
+```
+- caddy (reverse proxy pro frontend a backend)
+- web (frontend aplikace)
+- server (backend aplikace)
+- mysql (MySQL databáze)
+```
+Co může `tourdeapp.yaml` obsahovat je v [kde??]().
+
+## Lokální vývoj
+
+Pro lokální vývoj je potřeba pustit
+- **frontend** (`apps/web`), pomocí `npm run dev` (ve správném adresáři), pustí se na [http://localhost:3001](http://localhost:3001)
+- **backend** (`apps/server`), pomocí `npm run dev` (ve správném adresáři), pustí se na [http://localhost:3000](http://localhost:3000)
+- **MySQL** databázi, která je definována v `docker-compose.yaml`, pomocí `docker compose up -d mysql` (v kořenovém adresáři repozitáře), databáze poběží na portu 3306
+
+### Prerekvizity
+
+#### Windows
+
+- Nainstalovaný [WSL2 (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install)
+- Nainstalovaný a běžící [Docker](https://www.docker.com/)
+- Nainstalovaný [Node.js](https://nodejs.org/en/download/)
+- Nainstalovaný [npm](https://www.npmjs.com/get-npm) (bývá součástí Node.js)
+
+#### Linux / MacOS
+
+- Nainstalovaný a běžící [Docker](https://www.docker.com/)
+- Nainstalovaný [Node.js](https://nodejs.org/en/download/)
+- Nainstalovaný [npm](https://www.npmjs.com/get-npm) (bývá součástí Node.js)
+
+## Odevzdání
+
+Jak odevzdat svojí aplikaci můžete najít v našich [kde??]()