跳到主要内容

项目概览

ChurchApps 由大约 20 个独立的代码仓库组成,每个仓库都发布在 ChurchApps GitHub 组织下。本页按类别完整列出所有项目,并说明它们的框架、端口及相互关系。

开始之前

后端 API​

所有 API 均使用 Node.js、Express 和 TypeScript 构建,并通过 Serverless Framework 部署到 AWS Lambda。

项目用途开发端口数据库
Api核心模块化单体,涵盖会员、考勤、内容、奉献、消息和事工8084每个模块使用独立的 MySQL 数据库(共 6 个)
LessonsApiLessons.church 后端--单个 lessons MySQL 数据库
AskApi基于 OpenAI 的 AI 查询工具----
信息

核心 Api 项目是一个模块化单体。每个模块(会员、考勤、内容、奉献、消息、事工)都有自己的数据库,并可通过 /membership 或 /giving 等子路径访问。在生产环境中,这些模块以独立的 Lambda 函数形式部署,并位于 API Gateway 之后。

Web 应用​

项目框架开发端口用途
B1AdminReact 19 + Vite + MUI 73101教会管理仪表板
B1AppNext.js 16 + React 19 + MUI 73301面向公众的教会成员应用
LessonsAppNext.js 163501Lessons.church 前端
B1TransferReact + Vite--数据导入/导出工具
BrochureSites静态--静态教会宣传册网站

移动应用​

所有移动应用均使用 React Native 与 Expo 构建。

项目用途关键版本
B1Checkin签到自助终端应用Expo
LessonsScreenAndroid TV 课程展示Expo
FreePlay内容播放(包括电视操作系统)Expo
FreeShowRemoteFreeShow 的移动遥控器Expo

桌面应用​

项目技术栈用途
FreeShowElectron 37 + Svelte 3 + Vite演示和敬拜软件

共享库​

共享代码以 @churchapps 作用域发布到 npm,并作为常规 npm 依赖被上述项目使用。所有共享包都位于同一个代码仓库 —— Packages 中,该仓库以 Yarn workspace 方式管理,并通过 changesets 发布。

包用途使用者
@churchapps/helpers基础工具和共享的 TypeScript 接口(DateHelper、ApiHelper、CurrencyHelper 等)所有项目
@churchapps/apihelperExpress 服务器工具(认证、基础控制器、数据库访问、AWS 集成)所有 API
@churchapps/apphelperReact 组件库,包含用于登录、捐赠、表单、Markdown 和网站构建的子路径模块所有 Web 应用
@churchapps/content-providers第三方内容提供方抽象层(Lessons.church、Planning Center、Dropbox 等)Api、B1Admin、B1App、FreePlay
@churchapps/integration-sdkB1.church 集成工具包:Webhook、REST 客户端、OAuth外部集成开发者
@churchapps/texting短信服务提供方抽象层Api

有关工作区设置和发布流程,请参阅共享库。

项目关系​

前端应用                   共享库                     后端 API
-------------- ---------------- ------------
B1Admin ──────┐
B1App ──────┤ @churchapps/helpers ◄───── Api
LessonsApp ──────┼──► @churchapps/apphelper LessonsApi
FreeShow ──────┘ AskApi
@churchapps/apihelper ◄────┘

所有前端应用都依赖 @churchapps/helpers。Web 应用还额外依赖 @churchapps/apphelper 包。所有后端 API 都同时依赖 @churchapps/helpers 和 @churchapps/apihelper。

后续步骤​