Przegląd projektu
ChurchApps składa się z około 20 niezależnych repozytoriów, każde opublikowane w organizacji ChurchApps na GitHubie. Ta strona zawiera pełny spis wszystkich projektów uporządkowanych według kategorii, wraz z ich frameworkami, portami i powiązaniami.
Zanim zaczniesz
- Zainstaluj wymagania wstępne dla kategorii projektów, nad którymi chcesz pracować
Backendowe API
Wszystkie API są zbudowane w oparciu o Node.js, Express i TypeScript i są wdrażane w AWS Lambda za pomocą Serverless Framework.
| Projekt | Przeznaczenie | Port deweloperski | Baza danych |
|---|---|---|---|
| Api | Główny modularny monolit obejmujący członkostwo, frekwencję, treści, dary, komunikację i zadania | 8084 | Osobna baza MySQL dla każdego modułu (łącznie 6) |
| LessonsApi | Backend Lessons.church | -- | Pojedyncza baza MySQL lessons |
| AskApi | Narzędzie do zapytań AI oparte na OpenAI | -- | -- |
Główny projekt Api to modularny monolit. Każdy moduł (membership, attendance, content, giving, messaging, doing) ma własną bazę danych i jest dostępny pod podścieżką, np. /membership lub /giving. W środowisku produkcyjnym są one udostępniane jako osobne funkcje Lambda za API Gateway.
Aplikacje webowe
| Projekt | Framework | Port deweloperski | Przeznaczenie |
|---|---|---|---|
| B1Admin | React 19 + Vite + MUI 7 | 3101 | Panel administracyjny kościoła |
| B1App | Next.js 16 + React 19 + MUI 7 | 3301 | Publiczna aplikacja dla członków kościoła |
| LessonsApp | Next.js 16 | 3501 | Frontend Lessons.church |
| B1Transfer | React + Vite | -- | Narzędzie do importu i eksportu danych |
| BrochureSites | Statyczny | -- | Statyczne strony internetowe kościołów w formie broszur |
Aplikacje mobilne
Wszystkie aplikacje mobilne korzystają z React Native z Expo.
| Projekt | Przeznaczenie | Kluczowe wersje |
|---|---|---|
| B1Checkin | Aplikacja kiosku do zameldowania | Expo |
| LessonsScreen | Wyświetlanie lekcji na Android TV | Expo |
| FreePlay | Odtwarzanie treści (w tym na systemach TV) | Expo |
| FreeShowRemote | Mobilny pilot zdalnego sterowania dla FreeShow | Expo |
Aplikacje desktopowe
| Projekt | Stos technologiczny | Przeznaczenie |
|---|---|---|
| FreeShow | Electron 37 + Svelte 3 + Vite | Oprogramowanie do prezentacji i nabożeństw |
Biblioteki współdzielone
Współdzielony kod jest publikowany w npm w zakresie @churchapps i jest używany jako zwykłe zależności npm przez wyżej wymienione projekty. Wszystkie współdzielone pakiety znajdują się w jednym repozytorium -- Packages -- zarządzanym jako workspace Yarn i wydawanym za pomocą changesets.
| Pakiet | Przeznaczenie | Używany przez |
|---|---|---|
@churchapps/helpers | Podstawowe narzędzia i współdzielone interfejsy TypeScript (DateHelper, ApiHelper, CurrencyHelper itd.) | Wszystkie projekty |
@churchapps/apihelper | Narzędzia serwera Express (uwierzytelnianie, kontrolery bazowe, dostęp do bazy danych, integracje AWS) | Wszystkie API |
@churchapps/apphelper | Biblioteka komponentów React z podmodułami dla logowania, darowizn, formularzy, markdown i tworzenia stron internetowych | Wszystkie aplikacje webowe |
@churchapps/content-providers | Abstrakcja dostawców treści zewnętrznych (Lessons.church, Planning Center, Dropbox i inni) | Api, B1Admin, B1App, FreePlay |
@churchapps/integration-sdk | Zestaw narzędzi do integracji B1.church: webhooki, klient REST, OAuth | Zewnętrzni deweloperzy integracji |
@churchapps/texting | Abstrakcja dostawców SMS | Api |
Informacje o konfiguracji workspace i procesie wydawania znajdziesz w Biblioteki współdzielone.
Powiązania między projektami
Aplikacje frontendowe Biblioteki współdzielone Backendowe API
--------------------- ------------------------ --------------
B1Admin ──────┐
B1App ──────┤ @churchapps/helpers ◄───── Api
LessonsApp ──────┼──► @churchapps/apphelper LessonsApi
FreeShow ──────┘ AskApi
@churchapps/apihelper ◄────┘
Wszystkie aplikacje frontendowe zależą od @churchapps/helpers. Aplikacje webowe dodatkowo zależą od pakietów @churchapps/apphelper. Wszystkie backendowe API zależą zarówno od @churchapps/helpers, jak i @churchapps/apihelper.
Następne kroki
- Zmienne środowiskowe -- Skonfiguruj pliki
.env, aby połączyć się z API - Lokalna konfiguracja API -- Skonfiguruj backendowe API lokalnie