Přejít na hlavní obsah

AppHelper

Balíček @churchapps/apphelper poskytuje sdílené React komponenty a pomocné funkce pro všechny webové aplikace ChurchApps. Je to jediný publikovaný balíček, který zpřístupňuje funkční moduly přes podcesty vstupních bodů -- přihlášení, dary, formuláře, Markdown a funkce webu/CMS -- a vedle nich nabízí základní sadu sdílených komponent a pomocných funkcí.

Než začnete

Vstupní body​

Balíček definuje podcesty exportů ve svém package.json, takže každý funkční modul lze importovat samostatně:

Vstupní bodObsah
@churchapps/apphelperZákladní komponenty, pomocné funkce a hooky
@churchapps/apphelper/loginUživatelské rozhraní pro přihlášení a registraci
@churchapps/apphelper/donationsKomponenty pro dary a příspěvky
@churchapps/apphelper/formsKomponenty pro odesílání formulářů
@churchapps/apphelper/markdownEditory a renderery pro Markdown a HTML
@churchapps/apphelper/websiteKomponenty tvorby webu a CMS

Kdo co používá​

Než změníte sdílený export, zkontrolujte, které aplikace jej importují:

Oblast exportuCo poskytujePoužívá
Kořen -- základní komponenty a hookyDisplayBox, InputBox, Loading, PageHeader, PersonAvatar, SmallButton, ErrorMessages, ExportLink, useMountedState, a dále znovu exportované pomocné funkce z @churchapps/helpers (ApiHelper, DateHelper, Locale, UserHelper atd.)B1Admin, B1App, B1Transfer, LessonsApp
Kořen -- rámec webuSiteHeader (navigace, uživatelská nabídka, oznámení)B1Admin, B1Transfer, LessonsApp
Kořen -- editory obsahu pro administraciImageEditor, HelpIconB1Admin
Kořen -- infrastruktura v reálném časeSocketHelper, SubscriptionManager, NotificationServiceB1Admin, B1App
Kořen -- úložiště chatu a přítomnostiConversationStore, PresenceStoreB1App
Kořen -- UI poznámek a zprávNotes (interní poznámky k osobám a úkolům); AddNote, SubscriptionToggle (zprávy členům)B1Admin (Notes), B1App (AddNote, SubscriptionToggle)
Kořen -- specifické pro LessonsAnalyticsHelper, FloatingSupport, SupportModalLessonsApp
./loginLoginPage, LogoutPageB1Admin, B1App, B1Transfer, LessonsApp
./markdownMarkdownEditor, MarkdownPreviewLight (sdílené); MarkdownPreview, HtmlEditor (úprava obsahu v administraci)B1Admin, B1App, LessonsApp
./donationsMultiGatewayDonationForm, RecurringDonations, PaymentMethods, StripePaymentMethod, DonationHelper/getPaymentProvider (sdílené); FundDonations (pouze administrace)B1Admin, B1App
./formsFormSubmissionEdit (vykresluje ConversationalForm, když je displayMode formuláře conversational)B1Admin, B1App
./websiteJádro vykreslování stránek sdílené editorem a rendererem (Element a renderery jednotlivých typů určené přes ElementRegistry, StyleHelper, DroppableArea, DraggableWrapper, Theme, YoutubeBackground, SectionDivider/parseDividerConfig); widgety pro celý web (AnnouncementBanner, Launcher a jejich pomocné funkce parse*Config); Animate, ElementBlock, NonAuthDonationWrapper, SermonElement používané pouze veřejným rendereremB1Admin (editor), B1App (komponenty editoru a renderer)

Aplikace B1Transfer a LessonsApp používají pouze kořenový vstupní bod a login -- podcesty donations, forms a website dnes využívají výhradně B1Admin a B1App.

Nastavení pro lokální vývoj​

Tento balíček je součástí pracovního prostoru Packages spolu s ostatními sdílenými knihovnami:

  1. Naklonujte pracovní prostor:

    git clone https://github.com/ChurchApps/Packages.git
  2. Nainstalujte závislosti v kořenovém adresáři pracovního prostoru:

    cd Packages && yarn install
  3. Spusťte Vite playground z adresáře balíčku:

    cd apphelper && yarn dev

    Vývojový server playground se spustí na http://localhost:3001. Nejprve zkopírujte playground/dotenv.sample do playground/.env a vyplňte požadované hodnoty.

Pro sestavení balíčku k použití (kompiluje do dist/ a kopíruje lokalizační soubory a CSS) spusťte yarn workspace @churchapps/apphelper build -- nebo yarn build v kořenovém adresáři, které sestaví všechny balíčky v pořadí podle závislostí. Pro testování nepublikovaného sestavení uvnitř aplikace, která balíček používá, použijte dočasný Yarn portal -- viz Lokální vývoj proti aplikaci, která balíček používá.

tip

Playground je nejrychlejší způsob, jak vyvíjet a testovat komponenty AppHelper. Využívá hot-reload vývojového serveru Vite, takže změny uvidíte v reálném čase.

Publikování​

Vydání probíhají přes changesets: u každé změny spusťte v kořenovém adresáři pracovního prostoru yarn changeset a až budete připraveni vydat, spusťte yarn publish-all. Úplný postup najdete v Přehledu sdílených knihoven.

varování

Export nikdy neodstraňujte ani nepřejmenovávejte, dokud není nahrazení publikováno a všichni uživatelé přesunuti -- před sloučením odstranění prohledejte všechny repozitáře, které balíček používají (grep).

Související články​

  • Helpers -- Základní balíček pomocných funkcí, který se používá spolu s AppHelper
  • Webové aplikace -- Webové aplikace, které tento balíček používají
  • Přehled sdílených knihoven -- Nastavení pracovního prostoru, postup vydání a práce s lokálními odkazy