Siirry pääsisällölle

B1 Admin

B1Admin on kirkkojen hallintanäkymä, React-pohjainen yhden sivun sovellus, joka on rakennettu Vite- ja Material-UI-kirjastoilla. Seurakunnan henkilökunta käyttää sitä henkilöiden, ryhmien, läsnäolon, lahjoitusten, sisällön ja muiden asioiden hallintaan.

Ennen aloittamista

Asennus​

1. Kloonaa repositorio​

git clone https://github.com/ChurchApps/B1Admin.git

2. Asenna riippuvuudet​

cd B1Admin
npm install

3. Määritä ympäristömuuttujat​

cp dotenv.sample.txt .env

Avaa .env ja määritä API-päätepisteet. Voit osoittaa ne joko jaettuun demo-rajapintaan (https://api.demo.churchapps.org) tai omaan paikalliseen API-instanssiisi. Esimerkkitiedostossa saattaa vielä olla vanhentuneita staging-osoitteita; korvaa ne.

4. Käynnistä kehityspalvelin​

npm start

Tämä käynnistää Vite-kehityspalvelimen. Sovellus on käytettävissä selaimessa, ja hot module replacement on käytössä.

Keskeiset ympäristömuuttujat​

MuuttujaKuvaus
REACT_APP_STAGEYmpäristön nimi (esim. demo esimerkkitiedoston mukaan, prod tai selfhost)
PORTKehityspalvelimen portti (oletus: 3101)
REACT_APP_*_APIKunkin moduulin API-päätepisteiden URL-osoitteet
tieto

postinstall-skripti kopioi kielitiedostot ja CSS-tiedostot paketista @churchapps/apphelper. Jos komponentit näyttävät tyylittömiltä, suorita npm run postinstall manuaalisesti.

Keskeiset komennot​

KomentoKuvaus
npm startKäynnistä Vite-kehityspalvelin
npm run buildTuotantoversion rakentaminen Vitellä
npm run testSuorita päästä päähän -testit Playwrightilla
npm run lintSuorita ESLint automaattisilla korjauksilla

Teknologiapino​

  • React 19 ja TypeScript
  • Vite rakennustyökaluihin ja kehityspalvelimeen
  • Material-UI 7 käyttöliittymäkomponentteihin
  • React Query 5 palvelimen tilan hallintaan
  • @churchapps/apphelper*-paketit jaettuihin komponentteihin

Julkaisu​

Tuotantoversiot julkaistaan S3 + CloudFront -palveluun:

  1. npm run build luo staattiset resurssit
  2. Resurssit synkronoidaan S3-bucketiin
  3. CloudFront-välimuistin mitätöinti käynnistetään, jotta uusi versio tarjoillaan
vihje

Yksityiskohtaiset julkaisuohjeet löydät Web-sovellusten julkaisu -oppaasta.