From 4ffce5adbbeb9fae5dcc1c3c93238d998abb14b6 Mon Sep 17 00:00:00 2001 From: mrfry Date: Tue, 16 Feb 2021 17:37:31 +0100 Subject: [PATCH] Devel readme update --- devel/readme.md | 79 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 70 insertions(+), 9 deletions(-) diff --git a/devel/readme.md b/devel/readme.md index 62b3e0e..ae7aa5e 100644 --- a/devel/readme.md +++ b/devel/readme.md @@ -1,18 +1,79 @@ -# Install +# Alapok -`npm install` +A weboldal Next.js-ben íródott, ami egy React.js keretrendszer -# Developments server +Next.js tutorial: https://nextjs.org/learn/basics/create-nextjs-app -`npm run dev` +React.js tutorial: https://reactjs.org/tutorial/tutorial.html -# Next.js +Bár React.js-re épül a keretrendszer, a Next.js tutorial sokkal könnyebb. De React.js alap tudás +szükséges. -A projekt Next.js keretrendszerben készült, ami nagyban hasonlít a React.js-hez. Ehhez minden -tudnivaló itt található meg: +Weboldal node-ban fut, amit innen lehet telepíteni: -https://nextjs.org/learn/basics/getting-started +https://nodejs.org/en/download/ -# Export statikus fájlokba +Az innentől írt `parancsokat` a projekt mappájában nyitott parancssorban lehet futtatni (shift-klikk a +fájl böngészőben -> "parancssor nyitása itt", vagy VScode terminál) + +Ajánlott IDE: VS code + +# Beüzemelés + +1. Szükséges npm csomagok telepítése: + + `npm install` + +2. Devel szerver indítása + + `npm run dev` + +3. Böngészőben megnyitás + + Elvileg a http://localhost:3000/ címen elérhető. + +4. Fejlesztés ! + + Innentől ha módosítod a projekt (majdnem) akármelyik fájlját és elmented, akkor a böngészőben + láthatod a módosítás eredményét + +# Mappa / fájl szerkezet + + * `src` + + Itt van minden forrás fájl + + * `devel` + + Fejlesztési információk és segítség + + * `out` + + Statikus export eredménye (több infó lentebb) + + * `public` + + Public mappa, mivel statikusan exportált fájlokat használ az éles szerver, ezért ennek nincs + jelentősége + + * `make.sh` + + A projekt előkészítése éles verzióban lévő használathoz + +# Statikusan exportált? + +Bővebben: https://nextjs.org/docs/advanced-features/static-html-export + +A weboldalt lehet statikus .html, .js és .css fájlokba exportálni, így elég egy fájl szervert indítani, +ami ezeket a fájlokat osztja meg. Az eredeti weboldal így működik élesben. Ebben az üzemmódban a +weboldal tökéletesen működik, néhány apró funkció nem működik csak, ami nincs is használva ebben a +projektben. `npm run export` + +A generált fájlok az 'out' mappában lesznek. + +# Egyéb + + * Projekt eslint-el van formázva, és "lintelve", ami nincs hozzáadva a projekt moduljaihoz + (globálisan rakd fel külön)