Hopp til hovedinnhold

Miljøvariabler

Hvert ChurchApps-prosjekt bruker en .env-fil for lokal konfigurasjon. Hvert prosjekt inkluderer en eksempelfil som du kopierer og tilpasser. Denne siden dekker miljøvariablene for API-er, webapper og mobilapper, inkludert hvordan du velger mellom demo- og lokale API-mål.

Før du begynner

  • Installer forutsetningene for prosjektet ditt
  • Klon prosjektrepositoriet du vil jobbe med
  • Se gjennom Prosjektoversikt for å forstå hvilke API-moduler prosjektet ditt trenger

Generelt mønster​

  1. Se etter dotenv.sample.txt eller .env.sample i prosjektets rotmappe.
  2. Kopier den til .env.
  3. Rediger verdiene etter behov.
# Eksempel for et prosjekt med .env.sample
cp .env.sample .env

# Eksempel for et prosjekt med dotenv.sample.txt
cp dotenv.sample.txt .env
Advarsel

Commit aldri .env-filer til versjonskontroll. De inneholder hemmeligheter som databasepassord, API-nøkler og JWT-hemmeligheter. Alle ChurchApps-prosjekter har .env i .gitignore, men dobbeltsjekk alltid før du committer.

Velge API-mål​

Den viktigste avgjørelsen er hvor frontend-en din peker for API-kall. Det finnes to alternativer:

Alternativ 1: Demo-API-er (anbefalt for frontend-utvikling)​

Bruk det delte demo-miljøet. Ingen lokal API- eller databaseoppsett er nødvendig. Det kjører den nyeste koden fra main, og eksempeldataene fylles på nytt hver natt.

# Base-URL-mønster
https://api.demo.churchapps.org/{module}

# Eksempler på modul-URL-er
https://api.demo.churchapps.org/membership
https://api.demo.churchapps.org/attendance
https://api.demo.churchapps.org/content
https://api.demo.churchapps.org/giving
https://api.demo.churchapps.org/messaging
https://api.demo.churchapps.org/doing
Advarsel

Staging-miljøet (api.staging.churchapps.org, api.staging.lessons.church og tilhørende verter) er avviklet. Noen eksempel-.env-filer kan fortsatt inneholde staging-URL-er; erstatt dem med demo- eller lokale verdier vist på denne siden. Det finnes ingen delt ikke-produksjons-Lessons-API -- kjør LessonsApi lokalt (den lytter på port 8090) når du trenger en.

Alternativ 2: Lokal API​

Kjør Api-prosjektet på maskinen din. Krever MySQL 8.0+ med databaser opprettet for hver modul. Se veiledningen lokalt API-oppsett.

# Base-URL-mønster
http://localhost:8084/{module}

# Eksempler på modul-URL-er
http://localhost:8084/membership
http://localhost:8084/attendance
http://localhost:8084/content
http://localhost:8084/giving
http://localhost:8084/messaging
http://localhost:8084/doing

API-miljøvariabler​

Kjerneprosjektet Api (.env.sample) har mest konfigurasjon. Her er de viktigste variablene:

Felles innstillinger​

VariabelBeskrivelseEksempel
ENVIRONMENTKjøremiljødev
SERVER_PORTHTTP-port for den lokale utviklingsserveren8084
ENCRYPTION_KEY192-bits krypteringsnøkkel for sensitive dataaSecretKeyOfExactly192BitsLength
JWT_SECRETHemmelighet for signering av JSON Web Tokensjwt-secret-dev
FILE_STOREHvor opplastede filer skal lagres (disk eller s3)disk
CORS_ORIGINTillatte CORS-opprinnelser (* for lokal utvikling)*

Databasetilkobling​

En enkelt base-URL peker API-et mot MySQL. API-et utleder én database per modul (/membership, /attendance, /content, /giving, /messaging, /doing, /reporting) fra denne basen.

VariabelEksempel
API_DATABASE_URLmysql://root:password@localhost:3306
Tips

Oppdater root:password med dine faktiske MySQL-legitimasjoner. Hver database per modul må finnes før API-et kjøres. Bruk npm run initdb for å opprette skjemaet for alle moduler, eller npm run initdb:membership for én enkelt modul.

WebSocket-innstillinger​

VariabelBeskrivelseEksempel
SOCKET_PORTPort for WebSocket-serveren8087
SOCKET_URLWebSocket-URL som klienter kobler tilws://localhost:8087

Miljøvariabler for webapper​

B1Admin (React + Vite)​

Eksempelfil: .env.sample

VariabelBeskrivelseEksempel (demo)
REACT_APP_STAGEMiljønavndemo
PORTPort for utviklingsserveren3101
REACT_APP_API_BASEEnkelt base-URL for alle ChurchApps-API-er (/membership, /attendance, /content, /giving, /messaging, /doing, /reporting legges til automatisk)https://api.demo.churchapps.org
REACT_APP_CONTENT_ROOTURL for innholdsleveringhttps://democontent.churchapps.org
REACT_APP_GOOGLE_ANALYTICSGoogle Analytics-ID (valgfritt)UA-123456789-1

For lokal API-utvikling, pek base-URL-en mot ditt lokale oppsett:

REACT_APP_API_BASE=http://localhost:8084

B1App (Next.js)​

Eksempelfil: .env.sample

VariabelBeskrivelseEksempel (demo)
NEXT_PUBLIC_API_BASEEnkelt base-URL for alle ChurchApps-API-er (/membership, /attendance, /content, /giving, /messaging, /doing, /reporting legges til automatisk)https://api.demo.churchapps.org
NEXT_PUBLIC_CONTENT_ROOTURL for innholdsleveringhttps://democontent.churchapps.org
NEXT_PUBLIC_GOOGLE_ANALYTICSGoogle Analytics-ID (valgfritt)UA-123456789-1
Info

Next.js krever NEXT_PUBLIC_-prefikset for alle miljøvariabler som må være tilgjengelige i nettleseren. Variabler som kun brukes på serveren trenger ikke dette prefikset.

LessonsApp (Next.js)​

Eksempelfil: dotenv.sample.txt

VariabelBeskrivelseEksempel (lokal LessonsApi)
STAGEMiljøtrinn (la den være uten verdi eller sett dev for lokal utvikling)dev
NEXT_PUBLIC_LESSONS_APIURL til Lessons-APIhttp://localhost:8090
NEXT_PUBLIC_CONTENT_ROOTURL for innholdsleveringhttp://localhost:8090/content
NEXT_PUBLIC_API_BASEChurchApps API-base brukt for innlogging (respekteres kun når STAGE er uten verdi eller dev)https://api.demo.churchapps.org

Miljøvariabler for mobilapper​

B1Checkin (React Native / Expo)​

Eksempelfil: dotenv.sample.txt

VariabelBeskrivelseEksempel
EXPO_PUBLIC_STAGEVelger API-settet appen kobler til: dev (lokal API på http://127.0.0.1:8084), staging eller prod (standard når den ikke er satt)dev

B1Checkin bruker kun API-modulene Membership og Attendance samt URL-en for innholdslevering. Adressene for hvert miljø er satt i src/helpers/EnvironmentHelper.ts.

Info

Expo inkluderer kun variabler med prefikset EXPO_PUBLIC_ i app-pakken. Start utviklingsserveren på nytt med yarn start --reset-cache etter endringer i .env.


Hurtigreferanse: plassering av eksempelfiler​

ProsjektEksempelfil
Api.env.sample
B1Admin.env.sample
B1App.env.sample
B1Checkindotenv.sample.txt
LessonsAppdotenv.sample.txt
AskApidotenv.sample.txt