Lumipat sa pangunahing nilalaman

Lokal na Setup ng API

Gagabayan ka ng gabay na ito sa pag-set up ng ChurchApps API para sa lokal na development. I-clone mo ang repository, i-configure ang mga koneksyon sa database, i-initialize ang schema, at simulan ang dev server na may hot reload.

Bago Ka Magsimula

  • I-install ang Node.js 24+, Git, at MySQL 8.0+ -- tingnan ang Prerequisites
  • Gumawa ng MySQL user na may pribilehiyo sa paggawa ng database
  • Repasuhin ang sanggunian ng Environment Variables para sa configuration ng API

Hakbang-hakbang na Setup​

1. I-clone ang repository​

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

2. I-install ang mga dependency​

Gumagamit ang proyekto ng Yarn (hinaharangan ng guard ang npm install):

cd Api
yarn install

3. I-configure ang mga environment variable​

cp .env.sample .env

Buksan ang .env at i-configure ang iyong mga MySQL connection string. Kailangan ng bawat module ng sariling koneksyon sa database sa sumusunod na format:

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

Kakailanganin mo ng connection string para sa lahat ng anim na database ng module (membership, attendance, content, giving, messaging, doing).

4. I-initialize ang mga database​

npm run initdb

Awtomatikong gumagawa nito ng lahat ng anim na database at ng kanilang mga table.

Tip

Maaari mong i-initialize ang database ng isang module lang gamit ang npm run initdb -- --module=membership (o attendance, content, giving, messaging, doing).

5. Simulan ang dev server​

npm run dev

Magsisimula ang API na may hot reload sa http://localhost:8084.

Mga Pangunahing Command​

CommandPaglalarawan
npm run devSimulan ang dev server na may hot reload (tsx watch)
npm run buildLinisin, i-compile ang TypeScript, at kopyahin ang mga asset
npm run testPatakbuhin ang mga test gamit ang Jest (kasama ang coverage)
npm run test:watchPatakbuhin ang mga test sa watch mode
npm run lintPatakbuhin ang ESLint na may auto-fix (ESLint ang tanging formatter)

Deployment​

Inalis na ang staging environment. Dine-deploy ang Api sa demo environment sa bawat push sa main at sa production sa pamamagitan ng manual na workflow na Deploy Prod, na naglalapat din ng mga nakabinbing database migration. Tingnan ang API Deployment para sa mga detalye.

Lokal na Library Development​

Kung kailangan mong i-develop ang isang shared library (@churchapps/helpers o @churchapps/apihelper) kasabay ng API, buuin ito sa Packages workspace at magdagdag ng pansamantalang Yarn portal sa API:

# Sa Packages workspace
yarn build

# Sa API directory
yarn link ../Packages/helpers
# ... subukan ...
yarn unlink ../Packages/helpers && yarn install

Nagpapahintulot ito na subukan ang mga pagbabago sa library laban sa API nang hindi ini-publish sa npm. Tingnan ang Shared Libraries para sa mga detalye -- at huwag kailanman i-commit ang portal resolution na isinusulat ng link sa package.json.

Mga Kaugnay na Artikulo​

  • Database -- Pag-unawa sa arkitekturang database-per-module
  • Module Structure -- Paano inaayos ang mga controller, repository, at model
  • Shared Libraries -- Pagtatrabaho sa @churchapps/helpers at @churchapps/apihelper