Revize a4b7eec8
Přidáno uživatelem Lukáš Vlček před téměř 3 roky(ů)
webapp/README.md | ||
---|---|---|
10 | 10 |
* Openapi Generator |
11 | 11 |
* Sweet Alert 2 |
12 | 12 |
|
13 |
Klientská část je postavena na systému [Node.js](https://nodejs.org/en/) společně s frameworkem [Next.js](https://nextjs.org/)
|
|
14 |
a je implementována v programovacím jazyce javascript doplněném o knihovnu [React](https://reactjs.org/) a [Typescript](https://www.typescriptlang.org/).
|
|
15 |
Dále se v projektu využívají komponenty knihovnen [Ant Design](https://ant.design/) a [Bootstrap](https://react-bootstrap.netlify.app/).
|
|
13 |
Frontend (UI) anotační aplikace je postaven na React frameworku [Next.js](https://nextjs.org/) (využívající systém [Node.js](https://nodejs.org/en/))
|
|
14 |
a je implementován v programovacím jazyce TypeScript (některé knihovny jsou implementovány "jen" v JavaScriptu).
|
|
15 |
Velká část UI komponent a implementace rozložení využívá (obvykle upravené) komponenty z UI frameworků [Ant Design](https://ant.design/) (tabulky, tlačítka, modály...) a [Bootstrap](https://react-bootstrap.netlify.app/) (některé layout prvky, taby...).
|
|
16 | 16 |
|
17 | 17 |
## Spuštění vývojového prostředí |
18 | 18 |
Před spuštěním je nutno nainstalovat všechny knihovny pomocí balíčkovacího systému [yarn](https://yarnpkg.com/) (příkaz `yarn install`). |
19 |
Dále je potřeba mít vygenerované API pro komunikaci se serverem. API se generuje pomocí skriptu `"generate-api"` definovaném v souboru `package.json`. |
|
20 |
Pro úspěšné vygenerování je potřeba mít spuštěnou serverovou část aplikace a správně nastavenou její url adresu ve zmíněném skriptu. Po nainstalování |
|
21 |
balíčků a vygenerování API stačí již klientskou část spustit pomocí příkazu `yarn run dev`. Aplikace pak defaultně běží na adrese _http://localhost:3000/_. |
|
19 |
|
|
20 |
V případě změny REST API je potřeba upravit (přegenerovat) API client pro komunikaci se serverem. K automatickému generování API se používá knihovna OpenApiGenerator, neboť |
|
21 |
server publikuje rozhraní ve formátu OpenApi (resp. Swagger). Pro snazší použití je připraven skript `"generate-api"` definovaný v souboru `package.json` (který je možné spustit příkazem `yarn generate-api`). |
|
22 |
Pro úspěšné automatické vygenerování API client je potřeba mít spuštěnou serverovou část aplikace a správně nastavenou její url adresu ve zmíněném skriptu. |
|
23 |
|
|
24 |
Po nainstalování balíčků a případném vygenerování (aktualizaci) API clienta stačí již klientskou část spustit pomocí příkazu `yarn dev`. Aplikace pak ve výchozím nastavení poběží na adrese _http://localhost:3000/_. |
|
22 | 25 |
|
23 | 26 |
## Struktura |
24 | 27 |
Klientská část aplikace je členěna do adresářů: |
25 |
* `api` - vygenerované API
|
|
28 |
* `api` - vygenerované třídy API client
|
|
26 | 29 |
* `components` - komponenty |
27 | 30 |
* `contexts` - kontexty |
28 | 31 |
* `hooks` - React Hooks |
Také k dispozici: Unified diff
Frontend Readme updated