Пријавите се на главни садржај

AppHelper

Пакет @churchapps/apphelper пружа дељене React компоненте и помоћне функције за све ChurchApps веб апликације. То је један објављени пакет који кроз подпутање за улазне тачке излаже функционалне модуле -- пријаву, донације, обрасце, markdown и функционалност веб-сајта/CMS-а -- уз скуп основних дељених компоненти и помоћних функција.

Пре почетка

Улазne тачке​

Пакет у свом package.json фајлу дефинише подпутање за извоз, тако да се сваки функционални модул може увести засебно:

Улазна тачкаСадржај
@churchapps/apphelperОсновне компоненте, помоћне функције и hook-ови
@churchapps/apphelper/loginКориснички интерфејс за пријаву и регистрацију
@churchapps/apphelper/donationsКомпоненте за давања и донације
@churchapps/apphelper/formsКомпоненте за слање образаца
@churchapps/apphelper/markdownMarkdown и HTML уређивачи и приказивачи
@churchapps/apphelper/websiteКомпоненте градитеља веб-сајтова и CMS-а

Ко шта користи​

Пре измене дељеног извоза, проверите које апликације га увозе:

Област извозаШта пружаКористе
Root -- основне компоненте и hook-овиDisplayBox, InputBox, Loading, PageHeader, PersonAvatar, SmallButton, ErrorMessages, ExportLink, useMountedState, као и реекспортоване помоћне функције из @churchapps/helpers (ApiHelper, DateHelper, Locale, UserHelper итд.)B1Admin, B1App, B1Transfer, LessonsApp
Root -- chrome сајтаSiteHeader (навигација, кориснички мени, обавештења)B1Admin, B1Transfer, LessonsApp
Root -- уређивачи административног садржајаImageEditor, HelpIconB1Admin
Root -- инфраструктура за реално времеSocketHelper, SubscriptionManager, NotificationServiceB1Admin, B1App
Root -- складишта за ћаскање и присуствоConversationStore, PresenceStoreB1App
Root -- белешке и интерфејс за порукеNotes (интерне белешке о особама/задацима); AddNote, SubscriptionToggle (поруке за чланове)B1Admin (Notes), B1App (AddNote, SubscriptionToggle)
Root -- специфично за LessonsAnalyticsHelper, FloatingSupport, SupportModalLessonsApp
./loginLoginPage, LogoutPageB1Admin, B1App, B1Transfer, LessonsApp
./markdownMarkdownEditor, MarkdownPreviewLight (дељене); MarkdownPreview, HtmlEditor (уређивање административног садржаја)B1Admin, B1App, LessonsApp
./donationsMultiGatewayDonationForm, RecurringDonations, PaymentMethods, StripePaymentMethod, DonationHelper/getPaymentProvider (дељене); FundDonations (само административно)B1Admin, B1App
./formsFormSubmissionEdit (приказује ConversationalForm када је displayMode обрасца conversational)B1Admin, B1App
./websiteОснова за приказ странica коју деле уређивач и приказивач (Element и рендерери по типу које разрешава ElementRegistry, StyleHelper, DroppableArea, DraggableWrapper, Theme, YoutubeBackground, SectionDivider/parseDividerConfig); виџети за цео сајт (AnnouncementBanner, Launcher и њихови помоћници parse*Config); Animate, ElementBlock, NonAuthDonationWrapper, SermonElement које користи само јавни приказивачB1Admin (уређивач), B1App (компоненте уређивача и приказивач)

B1Transfer и LessonsApp користе само root и login улазне тачке -- подпутање donations, forms и website тренутно користе искључиво B1Admin и B1App.

Подешавање за локални развој​

Овај пакет се налази у Packages радном простору, заједно са другим дељеним библиотекама:

  1. Клонирајте радни простор:

    git clone https://github.com/ChurchApps/Packages.git
  2. Инсталирајте зависности у корену радног простора:

    cd Packages && yarn install
  3. Покрените Vite playground из директоријума пакета:

    cd apphelper && yarn dev

    Развојни сервер playground-а се покреће на http://localhost:3001. Прво копирајте playground/dotenv.sample у playground/.env и попуните потребне вредности.

Да бисте изградили пакет за коришћење (компајлира у dist/ и копира locale/CSS ресурсе), покрените yarn workspace @churchapps/apphelper build -- или yarn build у корену да бисте изградили све пакете по редоследу зависности. Да бисте тестирали необјављену верзију унутар апликације која га користи, користите привремени Yarn portal -- погледајте Локални развој против апликације која користи пакет.

савет

Playground је најбржи начин за развој и тестирање AppHelper компоненти. Vite развојни сервер се аутоматски освежава, па промене видите одмах.

Објављивање​

Издања иду кроз changesets: покрените yarn changeset у корену радног простора уз сваку измену, а затим yarn publish-all када будете спремни за издање. Погледајте Преглед дељених библиотека за цео ток.

упозорење

Никада не уклањајте нити преименујте извоз док замена није објављена и док сви корисници нису прешли на њу -- претражите све апликације које користе пакет пре спајања уклањања.

Повезани чланци​

  • Helpers -- Основни пакет помоћних функција који се користи уз AppHelper
  • Web Apps -- Веб апликације које користе овај пакет
  • Преглед дељених библиотека -- Подешавање радног простора, ток објављивања и workflow за локално повезивање