Combat tracker for Dungeons and Dragons (D&D) 5th Edition

A hivatalos Improved Initiative alkalmazás a https://www.improved-initiative.com

Local Development

Requirements

• Node.js (v12+)

Beállítás

• Klónozd a repót egy mappába a számítógépeden
• Nyisd meg a klónozott mappát egy kódszerkesztőben, például a Visual Studio Code-ban
• Nyiss egy terminál ablakot (a Powershell az ajánlott terminál alkalmazás ehhez a projekthez)
• Futtasd a következő parancsokat a terminál ablakban a dev környezet kódjának elkészítéséhez:

npm installnpx grunt

• A dev-kiszolgáló futtatásához vagy:
  • Nyomja meg a F5 gombot a Visual Studio Code-ban, vagy
  • Egy új terminálablakban futtassa a npm run start
• Amikor a kiszolgáló már fut, látogasson el a http://localhost webböngészőben, hogy megtekinthesse a felhasználói felület fejlesztői változatát, amely reagál a kód módosításaira.
• Minden alkalommal, amikor módosítasz, várd meg, amíg befejeződik a fordítás, majd töltsd újra manuálisan a böngészőt.

A Improved Initiative fejlesztését a Patreon támogatja.

Ha többet szeretnél megtudni arról, hogyan járulhatsz hozzá kóddal a Improved Initiative-hez, lásd a TÁMOGATÁS.md.

Linting

A Improved Initiative az Eslintet használja a prettierrel a kódfájlok linteléséhez.

A linting automatikusan megtörténik commitkor, de manuálisan is futtatható a: npm run lint.

Alkalmazás beállításai

Az Improved Initiative példányát ezekkel a beállításokkal konfigurálhatja. Mindegyik opcionális, az alapfunkcióknak működniük kell, ha egyiket sem adod meg.

• PORT – Alapértelmezés szerint 80
• NODE_ENV – “production” értékre állítva kielégíti a react, “development” értékre állítva letiltja a html nézet gyorsítótárazását.
• BASE_URL – Abszolút URL-ekben használatos az ügyféloldalon. Visszaesik relatív urlokra, ha nem áll rendelkezésre. Ez a kanonikus URL a Patreon callback és a böngésző localStorage számára.
• SESSION_SECRET – A munkamenet folytonosságának megőrzésére szolgál az alkalmazás újraindításakor vagy ilyesmi esetén. Átadva az express-sessionnek.
• DEFAULT_ACCOUNT_LEVEL – “accountsync”-re vagy “epicinitiative”-re állítva, hogy a jutalmakat minden felhasználónak megadja. Hasznos, ha nincs DB.
• DEFAULT_PATREON_ID – Állítsa be a dummy Patreon felhasználói azonosítót, ha a DEFAULT_ACCOUNT_LEVEL beállítással fut.
• DB_CONNECTION_STRING – Adjon meg egy DB kapcsolati karakterláncot a munkamenet és a felhasználói fiókok tárolásához. A memóriában egyébként Mongo DB-t fog használni, ami az alkalmazás újraindításakor törlődik.
• METRICS_DB_CONNECTION_STRING – Adj meg egy DB kapcsolat karakterláncot a metrikák írásához.
• PATREON_URL, PATREON_CLIENT_ID, PATREON_CLIENT_SECRET – Konfiguráció a Patreon integrációhoz

Docker

A Improved Initiative Dockeren belüli futtatása lehetséges, de teljesen opcionális és jelenleg kísérleti. Óvatosan járjon el, és ha kétségei vannak, olvassa el a Docker dokumentációját.

A Docker-kép elkészítése

A Docker-kép elkészítéséhez egy fejlesztési build segítségével futtassa:

docker build -t improved-initiative:latest .

A kép elkészítéséhez egy termelési build segítségével futtassa:

docker build --build-arg NODE_ENV=production -t improved-initiative:prod .

Az alkalmazás futtatása Docker konténerben

Az alkalmazás elindításához a konténeren belül futtassa:

docker run -p80:80 --name improved-initiative improved-initiative:latest

Vagy a gyártási build futtatásához:

docker run -p80:80 --name improved-initiative improved-initiative:prod

A konténer leállítása és eltávolítása

Tételezve, hogy a konténert a fentiek szerint improved-initiative névvel indította el, a következő parancsok leállítják, majd eltávolítják a konténert:

docker stop improved-initiative

docker rm improved-initiative

Licenc

A Improved Initiative alkalmazás a MIT licenc alatt érhető el.