OnLaunch 镜像文档

概述和主要用途

OnLaunch 是一个允许应用开发者向应用用户发送更新、警告和维护通知的服务。该开源框架提供服务器端组件和易于集成的客户端库（支持 Swift、Kotlin 和 Flutter），用于与后端通信并显示用户界面。开发者可选择自托管服务器或使用托管服务，初始集成后无需额外开发工作即可管理通知。

!OnLaunch 示例截图

核心功能和特性

• 低维护成本：应用初始集成后无需额外开发任务
• 直观管理界面：通过图形用户界面(GUI)创建和管理消息，无需专业技术知识
• 多平台支持：提供 Android、iOS 和 Flutter 客户端库
• 灵活部署：支持本地部署和自托管
• 数据可视化：集成 Prisma Studio 便于数据库数据检查

使用场景和适用范围

适用于各类移动应用开发者，需要向用户推送以下类型通知的场景：

• 应用版本更新提醒
• 系统维护公告
• 重要功能变更通知
• 安全警告或使用提示
• 服务状态通知

使用方法和配置说明

前提条件

• Node.js 环境
• Docker 环境
• Yarn（推荐）

安装与设置

1. 克隆仓库

bash
git clone [***]

2. 进入项目目录

bash
cd OnLaunch

3. 安装依赖包

bash
yarn install

4. 配置环境变量

复制 .env.example 文件并命名为 .env，根据需求修改环境变量配置。

5. 集成移动应用客户端

根据开发平台选择对应的客户端库进行集成：

• Android 客户端
• iOS 客户端
• Flutter 客户端

本地部署步骤

1. 启动 Next.js 服务器

bash
yarn dev

2. 启动 Docker 资源

bash
docker compose up

此命令将启动 Postgres 数据库和 Mailhog 实例。

3. 运行 Prisma Studio（数据库管理工具）

bash
yarn prisma studio

通过 Prisma Studio 可方便地查看和管理数据库中的数据。

技术栈

• Next.js - 服务端渲染框架
• Chakra UI - UI 组件库
• Tailwind CSS - CSS 框架
• Prisma.io - ORM 工具
• Docker - 容器化平台

许可证

采用 Apache 2.0 许可证 分发。

致谢

感谢 netidee 对本项目的部分资助！

详细文档请参见 文档概述。