ApiHelper
Il pacchetto @churchapps/apihelper fornisce utilità lato server per tutti gli API Express.js di ChurchApps. Include la classe di controller base, l'autenticazione JWT, le utilità del database e le integrazioni AWS che ogni progetto API dipende.
Prima di Iniziare
- Installa Node.js e Git — vedi Prerequisiti
- Familiarizzati con la configurazione del workspace Packages e il flusso di rilascio
- Questo pacchetto dipende da
@churchapps/helpers(come dipendenza peer) e lo re-esporta
Cosa Incluso
- CustomBaseController — classe base per i controller API, costruita su
inversify-express-utils - Auth — autenticazione JWT tramite
CustomAuthProvider,AuthenticatedUserePrincipal - Utilità del database —
DB.query/DB.queryOnee la classePoolper la gestione della connessione MySQL, piùMySqlHelpereDBCreatorper la configurazione dello schema - Integrazioni AWS —
AwsHelperper l'archiviazione di file S3 e letture SSM Parameter Store - Email —
EmailHelperche supporta i trasporti SES e SMTP - Caricamento della configurazione —
EnvironmentBaselegge le stringhe di connessione e i segreti dalle variabili di ambiente o Parameter Store - Misc —
EncryptionHelper,FileStorageHelper,LoggingHelper,BasePermissions,SlugHelper
Setup per Sviluppo Locale
Questo pacchetto vive nel workspace Packages accanto alle altre librerie condivise:
-
Clona il workspace:
git clone https://github.com/ChurchApps/Packages.git -
Installa le dipendenze alla radice del workspace:
cd Packages && yarn install -
Crea (compila TypeScript a
dist/):yarn build