Nahozeni sablony na backend, nasazeni ejs, aktualizace Bootstrapu

README.md

@@ -0,0 +1,36 @@
+
+# Svatbonet - 2. část MI-NUR
+
+
+
+## Zprovoznění aplikace
+
+Pro spuštění aplikace je potřeba mít nainstalovaný nodeJS. Po naklonování repozitáře stačí spustit příkaz `npm install`, následně `npm run build`, čímž dojde k přeložení SCSS a JS do jednoho souboru (pomocí webpacku). Následně příkazem `node src/app.js` dojde ke spuštění aplikace na adrese http://localhost:8080.
+
+Od této chvíle není potřeba nic řešit, stačí jen plnit šablony.
+
+## Šablony
+
+Šablony se nachází v adresáři `src/views`. V podadresáři backend jsou šablony pro zobrazení v rámci backendu aplikace. V `editor` jsou zase šablony pro použití v editoru webu.
+
+Jméno šablony se zobrazuje na základě URL. Přístup na url `http://localhost:8080/budget` zobrazuje šablonu `src/views/backend/budget.ejs`. V případě přístupu na URL, které vede na neexistující šablonu aplikace vypíše cestu k souboru.
+
+## Styly a skripty
+
+V adresáři `dist` existují dva soubory - `custom.css` a `custom.js`. Tyto slouží k psaní samostatného CSS resp. javascriptu. To proto, aby nebylo potřeba po každé změně kompilovat assets (spouštět `npm run build`). Tyto dva soubory se vkládají do hlaviček layoutů jak v backendu, tak i v editoru.
+
+Potřebné skripty a styly (jQuery, Bootstrap atp.) jsou načtené ve vygenerovaném `dist/bundle.js`.
+
+## Bootstrap 4.1
+
+Aplikaci jsem přehodil na Bootstrap 4.1. Dokumentace k němu je zde: https://getbootstrap.com/docs/4.1/getting-started/introduction/
+
+## Backend
+
+Aplikace vyžaduje spuštění, aby bylo možné použít šablonovací systém. Tím je ejs (https://ejs.co/#docs). Mimo jiné podporuje layouty (před doplněk) a cykly. Tím pádem drobná změna ve společné části je otázkou změny na jednom místě. Stejně tak nemusíme dvacetkrát pod sebe kopírovat obsah, stačí ho jen hodit do cyklu.
+
+V budoucnu bude backend řešit triviální pamatování obsahu, to zatím řešeno není.
+
+# Shrnutí
+
+Pro úpravu šablony stačí editovat soubor, jehož jméno se shoduje s částí URL adresy, doplnit patřičné styly do `dist/custom.css` a skripty do `dist/custom.js`. Tím by potřebné kroky měly být hotové.