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

Virallinen Improved Initiative -sovellus asuu osoitteessa https://www.improved-initiative.com

Local Development

Requirements

• Node.js (v12+)

Asennus

• Kloonaa repo kansioon tietokoneellesi
• Avaa kloonattu kansio koodieditorissa, kuten Visual Studio Code
• Avaa terminaali-ikkuna (Powershell on suositeltava terminaalisovellus tälle projektille)
• Ajoita terminaali-ikkunassa seuraavat komennot rakentaaksesi dev-ohjelman koodin:

npm installnpx grunt

• Voidaksesi saada dev-palvelimen käyntiin voit joko:
  • Painaa F5 Visual Studio Code -koodissa tai
  • Uudessa terminaali-ikkunassa suorita npm run start
• Heti kun palvelin on käynnissä, vieraile selaimessasi osoitteessa http://localhost katsellaksesi kehittämisversiota käyttöliittymästä, joka vastaa koodimuutoksiisi.
• Joka kerta, kun teet muutoksen, odota, että se on kääntynyt loppuun, ja lataa sitten selaimesi manuaalisesti uudelleen.

Parannetun aloitteen kehittämistä tuetaan Patreon-rahaston kautta.

Jos haluat lisätietoja siitä, miten voit osallistua koodin tuottamiseen Parannettuun aloitteeseen, lue kohdasta OSALLISTUMINEN.md.

Linting

Improved Initiative käyttää Eslintiä prettierin kanssa kooditiedostojen linttaamiseen.

Linting tapahtuu automaattisesti commit-toimituksen yhteydessä, mutta voit suorittaa sen myös manuaalisesti kautta: npm run lint.

Sovelluksen asetukset

Voit määrittää Improved Initiativen instanssin näillä asetuksilla. Kaikki ovat valinnaisia, perustoiminnallisuuden pitäisi toimia, jos et määritä mitään.

• PORT – Oletusarvo on 80
• NODE_ENV – Aseta arvoksi ”tuotanto” tyydyttääksesi reactin, aseta arvoksi ”kehitys” poistaaksesi html-näkymien välimuistitallennuksen käytöstä.
• BASE_URL – Käytetään absoluuttisissa URL-osoitteissa asiakaspuolella. Palaa suhteellisiin urleihin, jos niitä ei ole saatavilla. Tämä on kanoninen URL-osoite Patreon callbackia ja selaimen localStoragea varten.
• SESSION_SECRET – Käytetään pitämään istunnon jatkuvuus yllä sovelluksen uudelleenkäynnistyksen tai muun vastaavan aikana. Luovutetaan express-sessionille.
• DEFAULT_ACCOUNT_LEVEL – Asetetaan arvoksi ”accountsync” tai ”epicinitiative”, jos halutaan myöntää palkintoja kaikille käyttäjille. Hyödyllinen, jos sinulla ei ole DB:tä.
• DEFAULT_PATREON_ID – Asettaa dummy Patreon-käyttäjän id:n, kun ajetaan, kun DEFAULT_ACCOUNT_LEVEL on asetettu.
• DB_CONNECTION_STRING – Anna DB-yhteysmerkkijono istunnon ja käyttäjätilien tallennusta varten. Muistissa käytetään muuten Mongo DB:tä, joka tyhjennetään sovelluksen uudelleenkäynnistyksen yhteydessä.
• METRICS_DB_CONNECTION_STRING – Anna DB-yhteysmerkkijono, johon metriikat kirjoitetaan.
• PATREON_URL, PATREON_CLIENT_ID, PATREON_CLIENT_SECRET – Konfiguraatio Patreon-integraatiota varten

Docker

Käynnistäminen Parannettu aloite Docker-ohjelmassa onnistuu, mutta se on täysin valinnaista ja tällä hetkellä kokeellista. Toimi varovaisesti ja katso Dockerin dokumentaatiota, kun olet epävarma.

Docker-kuvan rakentaminen

Jos haluat rakentaa Docker-kuvan kehityskokoonpanolla, suorita:

docker build -t improved-initiative:latest .

Jos haluat rakentaa kuvan tuotantokokoonpanolla, suorita:

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

Sovelluksen suorittaminen Docker-kontissa

Käynnistääksesi sovelluksen kontissa, suorita:

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

Odota tuotantokehitys:

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

Kontin pysäyttäminen ja poistaminen

Olettaen, että olet käynnistänyt kontin nimellä improved-initiative, kuten edellä on esitetty, seuraavat komennot pysäyttävät kontin ja sen jälkeen poistavat sen:

docker stop improved-initiative

docker rm improved-initiative

Lisenssi

Parannettu aloite-sovellus on saatavilla MIT-lisenssillä.