跳到主要内容

前置条件

您需要的工具取决于您计划参与的项目。本页面按开发领域列出了所有必需的软件,从通用要求到平台特定的工具链。

开始之前

  • 查看项目概览以确定您想参与的项目
  • 确保在开发机器上拥有管理员权限以安装软件

所有项目

无论您参与哪个项目,以下都是必需的:

工具版本备注
Node.js20+B1App 和 LessonsApp(Next.js 16)需要版本 22+
npm随 Node.js 一起提供在所有项目中用作包管理器
Git最新版每个项目是一个单独的仓库
提示

使用 Node 版本管理器如 nvm(macOS/Linux)或 nvm-windows(Windows)来轻松切换 Node 版本。

后端 API 开发

如果您计划在本地运行 API(而不是指向 staging):

工具版本备注
MySQL8.0+每个 API 模块使用自己的数据库

核心 API 需要六个数据库:membershipattendancecontentgivingmessagingdoing。API 包含初始化 schema 的脚本——请参阅 API 本地设置指南。

移动应用开发

对于 B1Mobile、B1Checkin、LessonsScreen 或其他 React Native / Expo 应用:

工具版本备注
Expo CLI最新版全局安装:npm install -g expo-cli
Android Studio最新版Android 开发所需(包含 Android SDK)
Xcode最新版iOS 开发所需(仅限 macOS)
信息

您可以在物理设备上使用 Expo Go 应用进行快速测试,无需 Android Studio 或 Xcode。但是,构建生产二进制文件需要原生工具链。

FreeShow(桌面应用)开发

FreeShow 有额外的原生构建依赖,因为它编译原生 Node 模块(如 canvas):

所有平台

工具版本备注
Python3.12node-gyp 编译原生模块时需要
setuptools最新版通过 pip install setuptools 安装

Windows

工具备注
Visual StudioCommunity 版即可
"Desktop development with C++" 工作负载在 Visual Studio 安装期间选择
Windows 10 SDK包含在 C++ 工作负载中;确保已勾选

您可以通过命令行安装 Visual Studio 构建工具:

npm install --global windows-build-tools

或者安装 Visual Studio Community 并在安装期间选择"Desktop development with C++"工作负载。

Linux

sudo apt-get install libfontconfig1-dev

macOS

Xcode Command Line Tools 通常就足够了:

xcode-select --install

验证安装

运行以下命令确认所有内容已安装:

node --version    # Should print v20.x.x or higher
npm --version # Should print 10.x.x or higher
git --version # Should print git version 2.x.x
mysql --version # Only needed for local API development

后续步骤