跳到主要内容

开发者文档

ChurchApps 是由约 20 个开源项目组成的集合,共同提供一套完整的教会管理平台。这些项目涵盖后端 API、Web 应用、移动应用、桌面应用和共享库,全部使用 TypeScript 编写。本节提供搭建本地开发环境并开始参与贡献所需的全部内容。

架构概览​

这些项目是独立的代码仓库(而非单体仓库)。共享代码以 @churchapps/* 作用域发布到 npm,并作为常规依赖项被引用。这意味着你无需克隆整个生态系统,即可只针对单个项目进行开发。

主要特点:

  • 语言: 全程使用 TypeScript
  • 后端: Node.js / Express API,通过 Serverless Framework 部署到 AWS Lambda
  • Web: React 19(Vite 和 Next.js)、Material-UI 7
  • 移动端: React Native 与 Expo
  • 数据库: MySQL 8.0,每个 API 模块对应一个数据库

本节内容​

  • 设置 —— 本地开发环境、前置条件和配置
  • API —— 核心 API 的本地设置、数据库初始化和模块结构
  • Web 应用 —— 在本地运行 B1Admin、B1App 和 LessonsApp
  • 移动应用 —— 构建 B1Checkin 及其他 Expo 应用
  • 共享库 —— 使用 Helpers、ApiHelper 和 AppHelper
  • 部署 —— 部署 API、Web 应用和移动应用
  • FreePlay 内容提供方 —— 将你的课程库与 FreePlay 集成

社区与资源​

资源链接
GitHub 组织github.com/ChurchApps
问题跟踪ChurchAppsSupport Issues
Slack 社区加入 Slack
提示

开始参与贡献最快的方式,是选择一个 Web 应用(例如 B1Admin),将其指向共享的演示 API,然后直接开始修改前端。无需任何数据库或 API 设置。