AppHelper

Ang @churchapps/apphelper package ay nagbibigay ng shared React components at utilities para sa lahat ng ChurchApps web applications. Ito ay isang iisang published package na nagpapakita ng feature modules sa pamamagitan ng subpath entry points -- login, donations, forms, markdown, at website/CMS functionality -- kasama ang isang core set ng shared components at helpers.

Bago Kang Magsimula

• I-install ang Node.js at Git -- tingnan ang Prerequisites
• Maging pamilyar sa Packages workspace setup at release flow

Entry Points

Ang package ay nag-define ng subpath exports sa kanya na package.json, kaya ang bawat feature module ay importable sa sarili nito:

Entry point	Contents
@churchapps/apphelper	Core components, helpers, at hooks
@churchapps/apphelper/login	Login at registration UI
@churchapps/apphelper/donations	Giving at donation components
@churchapps/apphelper/forms	Form submission components
@churchapps/apphelper/markdown	Markdown at HTML editors at renderers
@churchapps/apphelper/website	Website builder at CMS components

Sino ang Kumakain ng Ano

Bago baguhin ang isang shared export, tingnan kung aling apps ang nag-import nito:

Export area	What it provides	Consumed by
Root -- core components & hooks	DisplayBox, InputBox, Loading, PageHeader, PersonAvatar, SmallButton, ErrorMessages, ExportLink, useMountedState, plus re-exported @churchapps/helpers utilities (ApiHelper, DateHelper, Locale, UserHelper, atbp.)	B1Admin, B1App, B1Transfer, LessonsApp
Root -- site chrome	SiteHeader (nav, user menu, notifications)	B1Admin, B1Transfer, LessonsApp
Root -- admin content editors	ImageEditor, HelpIcon	B1Admin
Root -- realtime plumbing	SocketHelper, SubscriptionManager, NotificationService	B1Admin, B1App
Root -- chat/presence stores	ConversationStore, PresenceStore	B1App
Root -- notes & messaging UI	Notes (staff notes sa people/tasks); AddNote, SubscriptionToggle (member messaging)	B1Admin (Notes), B1App (AddNote, SubscriptionToggle)
Root -- Lessons-specific	AnalyticsHelper, FloatingSupport, SupportModal	LessonsApp
./login	LoginPage, LogoutPage	B1Admin, B1App, B1Transfer, LessonsApp
./markdown	MarkdownEditor, MarkdownPreviewLight (shared); MarkdownPreview, HtmlEditor (admin content editing)	B1Admin, B1App, LessonsApp
./donations	MultiGatewayDonationForm, RecurringDonations, PaymentMethods, StripePaymentMethod, DonationHelper/getPaymentProvider (shared); FundDonations (admin lang)	B1Admin, B1App
./forms	FormSubmissionEdit (renders ConversationalForm kapag ang form's displayMode ay conversational)	B1Admin, B1App
./website	Page-rendering core shared ng editor at renderer (Element + ang per-type renderers na nalulutas sa pamamagitan ng ElementRegistry, StyleHelper, DroppableArea, DraggableWrapper, Theme, YoutubeBackground, SectionDivider/parseDividerConfig); site-wide widgets (AnnouncementBanner, Launcher + ang kanilang parse*Config helpers); Animate, ElementBlock, NonAuthDonationWrapper, SermonElement na ginagamit lamang ng public-facing renderer	B1Admin (editor), B1App (editor components + renderer)

Ang B1Transfer at LessonsApp ay gumagamit lamang ng root at login entry points -- ang donations, forms, at website subpaths ay kinakain nang eksklusibo ng B1Admin at B1App ngayon.

Setup para sa Local Development

Ang package na ito ay nabubuhay sa Packages workspace kasama ang iba pang mga shared libraries:

1. I-clone ang workspace:

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

2. I-install ang mga dependencies sa workspace root:

   cd Packages && yarn install

3. Ilunsad ang Vite playground mula sa package directory:

   cd apphelper && yarn dev

   Ang playground dev server ay nagsisimula sa http://localhost:3001. Kopyahin ang playground/dotenv.sample sa playground/.env at punin ang mga kinakailangang halaga nang una.

Upang bumuo ng package para sa pagkonsumo (nag-compile sa dist/ at nag-copy ng locale/CSS assets), patakbuhin ang yarn workspace @churchapps/apphelper build -- o yarn build sa root upang bumuo ng bawat package sa dependency order. Upang subukan ang isang hindi-published na build sa loob ng isang consuming app, gumamit ng isang pansamantalang Yarn portal -- tingnan ang Local Development Against a Consuming App.

Tip

Ang playground ay ang pinakamabilis na paraan upang bumuo at subukan ang AppHelper components. Ito ay hot-reloads ang Vite dev server upang makita mo ang mga pagbabago sa real time.

Publishing

Ang mga release ay dumadaan sa changesets: patakbuhin ang yarn changeset sa workspace root na may bawat pagbabago, pagkatapos ay yarn publish-all kapag handa nang mag-release. Tingnan ang Shared Libraries Overview para sa buong flow.

Babala

Huwag alisin o palitan ang isang export hanggang ang kapalit ay na-publish at bawat consumer ay naging migrate -- grep lahat ng consuming repos bago magsama ng removal.

Related Articles

• Helpers -- Ang base utility package na ginagamit kasama ang AppHelper
• Web Apps -- Ang web applications na kumakain ng package na ito
• Shared Libraries Overview -- Workspace setup, release flow, at local-link workflow