Pomôcky
Balík @churchapps/helpers poskytuje základné nástroje, ktoré používajú všetky projekty ChurchApps, či už frontendové, alebo backendové. Nie je viazaný na konkrétny framework a obsahuje bežné pomocné funkcie, ako sú DateHelper, ApiHelper, CurrencyHelper, a tiež spoločné rozhrania TypeScript, ktoré tvoria dátový kontrakt medzi aplikáciami a API.
Predtým, ako začnete
- Nainštalujte si Node.js a Git -- pozri Požiadavky
- Oboznámte sa s nastavením pracovného priestoru Packages a postupom vydávania
Kto ju používa
Každé API ChurchApps (hlavné Api, AskApi a LessonsApi) a každý webový frontend (B1Admin, B1App, B1Transfer, LessonsApp) priamo závisí na tomto balíku. Frontendy navyše získavajú mnohé jeho exporty (ApiHelper, DateHelper, UserHelper a ďalšie rozhrania) znovu exportované cez @churchapps/apphelper. Ostatné zdieľané balíky ho deklarujú ako peer závislosť, aby každá aplikácia používala presne jednu kópiu.
Nastavenie pre lokálny vývoj
Tento balík sa nachádza v pracovnom priestore Packages spolu s ostatnými zdieľanými knižnicami:
-
Naklonujte pracovný priestor:
git clone https://github.com/ChurchApps/Packages.git -
Nainštalujte závislosti v koreňovom adresári pracovného priestoru:
cd Packages && yarn install -
Zostavte balík (skompiluje TypeScript do
dist/):yarn workspace @churchapps/helpers buildAlebo spustite
yarn buildv koreňovom adresári, čím sa zostavia všetky balíky v poradí podľa závislostí.
Na testovanie zmien v projekte, ktorý balík používa, použite dočasný Yarn portal -- pozri Lokálny vývoj voči aplikácii, ktorá balík používa.
Vydávanie
Vydania prebiehajú cez changesety, nie cez ručné zvyšovanie verzií:
- V koreňovom adresári pracovného priestoru spustite
yarn changeset, vyberte@churchapps/helpersa zodpovedajúci typ zvýšenia verzie; vygenerovaný súbor changesetu potvrďte spolu so svojou zmenou. - Keď budete pripravení na vydanie, spustite v koreni
yarn publish-all-- zvýši verzie, zapíše CHANGELOGy, zostaví balíky v poradí podľa závislostí a publikuje ich na npm.
Nové zdieľané rozhrania patria do helpers/src/interfaces/ a sú znovu exportované cez hlavný súbor balíka. Katalóg typov prvkov stavebnice webov (ElementTypes.ts -- 35 typov so schémami ich odpovedí) sa tiež nachádza tu; je to kontrakt zdieľaný renderermi apphelper, formulármi editora B1Admin a promptami pre generovanie pomocou AI (pozri Architektúra stavebnice webov).
Keďže tento balík používa každý projekt ChurchApps, zmeny tu majú široký dosah. Vydanie helpers automaticky zvýši verzie apihelper a apphelper, aby ich rozsahy závislostí zostali aktuálne. Pred publikovaním otestujte balík pomocou Yarn portalu aspoň v jednom závislom API a jednej závislej webovej aplikácii.
Súvisiace články
- ApiHelper -- Serverové pomocné funkcie, ktoré závisia na tomto balíku
- AppHelper -- React komponenty, ktoré závisia na tomto balíku
- Prehľad zdieľaných knižníc -- Nastavenie pracovného priestoru, postup vydávania a workflow lokálneho prepojenia