Ugrás a fő tartalomra

Helyi API beállítása

Ez az útmutató végigvezet a ChurchApps API helyi fejlesztési környezetének beállításán. Klónozni fogod a tárolót, beállítod az adatbázis-kapcsolatokat, inicializálod a sémát, és elindítod a fejlesztői szervert újratöltéssel (hot reload).

Mielőtt elkezdi

  • Telepítse a Node.js 24+, a Git és a MySQL 8.0+ szoftvert -- lásd: Előfeltételek
  • Hozzon létre egy MySQL-felhasználót, amelynek van adatbázis-létrehozási jogosultsága
  • Tekintse át a Környezeti változók leírását az API konfigurációjához

Lépésről lépésre​

1. Klónozza a tárolót​

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

2. Telepítse a függőségeket​

A projekt a Yarn csomagkezelőt használja (egy védelem blokkolja az npm install parancsot):

cd Api
yarn install

3. Állítsa be a környezeti változókat​

cp .env.sample .env

Nyissa meg a .env fájlt, és állítsa be a MySQL-kapcsolati karakterláncokat. Minden modulnak saját adatbázis-kapcsolatra van szüksége a következő formátumban:

mysql://root:password@localhost:3306/dbname

Mind a hat modul adatbázisához (membership, attendance, content, giving, messaging, doing) kapcsolati karakterláncra lesz szüksége.

4. Inicializálja az adatbázisokat​

npm run initdb

Ez automatikusan létrehozza mind a hat adatbázist és a hozzájuk tartozó táblákat.

tipp

Egyetlen modul adatbázisát is inicializálhatja a npm run initdb -- --module=membership paranccsal (vagy attendance, content, giving, messaging, doing értékkel).

5. Indítsa el a fejlesztői szervert​

npm run dev

Az API újratöltéssel indul a http://localhost:8084 címen.

Fontos parancsok​

ParancsLeírás
npm run devFejlesztői szerver indítása újratöltéssel (tsx watch)
npm run buildTisztítás, TypeScript fordítás és az erőforrások másolása
npm run testTesztek futtatása Jesttel (lefedettség-méréssel)
npm run test:watchTesztek futtatása figyelő módban
npm run lintESLint futtatása automatikus javítással (az ESLint az egyetlen formázó)

Telepítés​

A staging környezet megszűnt. Az API minden main ágra történő push után a demo környezetbe települ, az éles környezetbe pedig a kézi Deploy Prod munkafolyamattal, amely a függőben lévő adatbázis-migrációkat is alkalmazza. Részletekért lásd: API telepítés.

Helyi könyvtárfejlesztés​

Ha egy megosztott könyvtárat (@churchapps/helpers vagy @churchapps/apihelper) kell az API-val párhuzamosan fejlesztenie, építse azt a Packages munkaterületen, és adjon hozzá egy ideiglenes Yarn portált az API-hoz:

# A Packages munkaterületen
yarn build

# Az API könyvtárban
yarn link ../Packages/helpers
# ... tesztelés ...
yarn unlink ../Packages/helpers && yarn install

Így a könyvtármódosításokat az API-val tesztelheti anélkül, hogy npm-re publikálná őket. Részletekért lásd: Megosztott könyvtárak -- és soha ne commitolja a package.json fájlba a link által írt portál-feloldást.

Kapcsolódó cikkek​

  • Adatbázis -- Az adatbázis modulonkénti felépítésének megértése
  • Modulszerkezet -- Hogyan szerveződnek a vezérlők, tárolók és modellek
  • Megosztott könyvtárak -- A @churchapps/helpers és @churchapps/apihelper használata