ApiHelper

Ang @churchapps/apihelper package ay nagbibigay ng mga server-side na utility para sa lahat ng ChurchApps Express.js API. Kasama dito ang base controller class, JWT authentication middleware, mga utility ng database, at mga integrasyon sa AWS na pinag-aaralan ng bawat proyekto ng API.

Bago Ka Magsimula

• Mag-install ng Node.js at Git -- tingnan ang Mga Pangangailangan
• Pamilyarisahin ang sarili sa daloy ng trabaho ng npm link para sa lokal na development
• Ang package na ito ay umaasa sa @churchapps/helpers

Mga Kasama

• CustomBaseController -- base class para sa mga API controller
• Auth middleware -- JWT authentication sa pamamagitan ng CustomAuthProvider
• Mga utility ng database -- DB.query, EnhancedPoolHelper para sa pamamahala ng koneksyon sa MySQL
• Mga integrasyon sa AWS -- mga helper para sa S3, SSM Parameter Store, at iba pang mga serbisyo ng AWS
• Pag-setup ng Inversify DI -- configuration ng dependency injection container

Pag-setup para sa Lokal na Development

1. I-clone ang repository:

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

2. Mag-install ng mga dependency:

   cd ApiHelper && npm install

3. Buuin ang package (nag-co-compile ng TypeScript sa dist/):

   npm run build

4. Gawing magagamit para sa lokal na pag-link:

   npm link

Mga Pangunahing Utos

Utos	Paglalarawan
npm run build	I-compile ang TypeScript sa dist/
npm run lint	Patakbuhin ang ESLint
npm run lint:fix	Patakbuhin ang ESLint na may auto-fix
npm run format	I-format ang code gamit ang Prettier

Impormasyon

Ang package na ito ay dependency ng bawat ChurchApps API. Kapag gumagawa ng mga pagbabago, gamitin ang npm link upang subukan laban sa isang API nang lokal bago mag-publish.

Mga Kaugnay na Artikulo

• Helpers -- Ang base utility package na pinag-aaralan ng package na ito
• Istraktura ng Module -- Kung paano ginagamit ang mga controller at auth middleware sa mga API module
• Lokal na Pag-setup ng API -- Pag-setup ng API para sa lokal na development