从源码到生产：Convex-Backend 完整编译指南

从源码到生产：Convex-Backend 完整编译指南

【免费下载链接】convex-backendThe open-source reactive database for app developers项目地址: https://gitcode.com/gh_mirrors/co/convex-backend

Convex-Backend 是一个开源的响应式数据库，专为应用开发者设计。本指南将带你从源码编译开始，逐步完成从开发环境到生产环境的部署，让你快速掌握这个强大工具的构建过程。

📋 编译前准备

在开始编译 Convex-Backend 之前，需要确保你的系统中安装了以下必要依赖：

核心依赖

• Just：用于执行脚本的工具，可通过cargo install just或brew install just安装
• Node.js：需与项目根目录下.nvmrc指定的版本一致，推荐使用 nvm 管理
• Cargo：Rust 构建系统，通过 rustup 安装
• Rush：Monorepo 包管理工具，安装命令：npm clean-install --prefix scripts

依赖安装验证

安装完成后，通过以下命令验证环境是否就绪：

just --version # 验证 Just 安装 node --version # 验证 Node.js 版本 cargo --version # 验证 Cargo 安装

🔨 源码编译步骤

1. 获取源码

首先克隆 Convex-Backend 仓库：

git clone https://gitcode.com/gh_mirrors/co/convex-backend cd convex-backend

2. 安装项目依赖

使用 Rush 安装 JavaScript 依赖：

just rush install

3. 构建开发环境

Convex-Backend 采用 Rust 编写，使用 Cargo 进行构建。开发环境构建命令：

just run-local-backend

该命令会编译并启动本地后端服务，默认使用 SQLite 数据库。如果遇到数据库元数据错误，可执行以下命令重置本地数据库：

rm convex_local_backend.sqlite3

4. 构建生产环境二进制文件

对于生产环境，建议使用发布模式构建：

cargo build --release -p convex-backend

构建完成后，可执行文件将位于target/release/convex-local-backend。

🚀 生产环境部署

生成安全密钥

生产环境部署需要生成实例密钥和管理员密钥：

1. 生成实例密钥：

   cargo run -p keybroker --bin generate_secret

2. 生成管理员密钥（需替换为实际的实例名称和密钥）：

   cargo run -p keybroker --bin generate_key -- convex-self-hosted <instance-secret>

启动生产服务

使用生成的密钥启动生产环境服务：

./target/release/convex-local-backend --instance-name convex-self-hosted --instance-secret <your-instance-secret>

数据库配置

Convex-Backend 支持多种数据库后端：

• PostgreSQL：

  ./convex-local-backend --db postgres-v5 <connection-string>

• MySQL：

  ./convex-local-backend --db mysql-v5 <connection-string>

Convex 系统架构示意图，展示了 Web 应用、服务器功能和数据库之间的关系

🔍 验证与测试

运行演示应用

部署完成后，可以通过内置的演示项目验证系统功能：

cd npm-packages/demos/tutorial just convex dev npm run dev:frontend

访问http://localhost:5173即可查看演示应用。

常用管理命令

• 列出数据库表：just convex data
• 管理环境变量：just convex env
• 查看日志：just convex logs --success
• 导入/导出数据：just convex import/just convex export

Convex 数据同步流程，展示了初始同步和增量同步的工作原理

⚙️ 高级配置

自定义端口与存储路径

通过命令行参数自定义服务配置：

./convex-local-backend --port 3001 --data-dir /path/to/data

性能优化

生产环境建议：

• 使用 PostgreSQL 或 MySQL 替代 SQLite
• 配置适当的内存和 CPU 资源
• 设置定期备份策略

Convex 查询订阅流程，展示了数据变更如何实时推送到前端

📚 相关资源

• 官方文档：self-hosted/advanced/running_binary_directly.md
• 配置示例：self-hosted/docker/docker-compose.yml
• 开发指南：CONTRIBUTING.md

通过以上步骤，你已经成功从源码编译并部署了 Convex-Backend 生产环境。如需进一步定制或扩展功能，请参考官方文档或项目源码中的示例。

【免费下载链接】convex-backendThe open-source reactive database for app developers项目地址: https://gitcode.com/gh_mirrors/co/convex-backend