Lokalt oppsett av API
Denne veiledningen går gjennom hvordan du setter opp ChurchApps API for lokal utvikling. Du kloner repositoriet, konfigurerer databasetilkoblingene, initialiserer skjemaet og starter utviklingsserveren med hot reload.
Før du begynner
- Installer Node.js 24+, Git og MySQL 8.0+ -- se Forutsetninger
- Opprett en MySQL-bruker med tillatelse til å opprette databaser
- Gå gjennom referansen for miljøvariabler for konfigurasjon av API-et
Trinn for trinn
1. Klon repositoriet
git clone https://github.com/ChurchApps/Api.git
2. Installer avhengigheter
Prosjektet bruker Yarn (en vakt blokkerer npm install):
cd Api
yarn install
3. Konfigurer miljøvariabler
cp .env.sample .env
Åpne .env og konfigurer MySQL-tilkoblingsstrengene dine. Hver modul trenger sin egen databasetilkobling i følgende format:
mysql://root:password@localhost:3306/dbname
Du trenger tilkoblingsstrenger for alle seks moduldatabasene (membership, attendance, content, giving, messaging, doing).
4. Initialiser databasene
npm run initdb
Dette oppretter alle seks databasene og tabellene deres automatisk.
Du kan initialisere databasen for én enkelt modul med npm run initdb -- --module=membership (eller attendance, content, giving, messaging, doing).
5. Start utviklingsserveren
npm run dev
API-et starter med hot reload på http://localhost:8084.
Viktige kommandoer
| Kommando | Beskrivelse |
|---|---|
npm run dev | Start utviklingsserveren med hot reload (tsx watch) |
npm run build | Rydd, kompiler TypeScript og kopier ressurser |
npm run test | Kjør tester med Jest (inkluderer dekningsrapport) |
npm run test:watch | Kjør tester i watch-modus |
npm run lint | Kjør ESLint med automatisk retting (ESLint er den eneste formateringsverktøyet) |
Utrulling
Staging-miljøet er avviklet. API-et rulles ut til demomiljøet ved hver push til main, og til produksjon gjennom den manuelle arbeidsflyten Deploy Prod, som også kjører ventende databasemigreringer. Se API-utrulling for detaljer.
Lokal bibliotekutvikling
Hvis du trenger å utvikle et delt bibliotek (@churchapps/helpers eller @churchapps/apihelper) sammen med API-et, bygg det i Packages-arbeidsområdet og legg til et midlertidig Yarn-portal i API-et:
# I Packages-arbeidsområdet
yarn build
# I API-katalogen
yarn link ../Packages/helpers
# ... test ...
yarn unlink ../Packages/helpers && yarn install
Dette lar deg teste endringer i biblioteket mot API-et uten å publisere til npm. Se Delte biblioteker for detaljer -- og commit aldri portal-oppløsningen som lenken skriver til package.json.
Relaterte artikler
- Database -- Forstå arkitekturen med én database per modul
- Modulstruktur -- Hvordan kontrollere, repositorier og modeller er organisert
- Delte biblioteker -- Arbeid med
@churchapps/helpersog@churchapps/apihelper