Convex 是一个开源的响应式数据库，旨在为网页应用开发者（无论是人类还是大语言模型）提供便捷。通过编写纯 TypeScript，你可以获取数据并执行具有强一致性的业务逻辑。

Convex 提供了一个数据库、一个用于编写服务器函数的地方以及客户端库。它使得构建和扩展动态实时更新应用变得简单。阅读文档以了解更多。

Convex 后端的开发由 Convex 团队主导。我们欢迎 bug 修复 并且乐于接收反馈。我们会在一两天内将内部开发工作的内容同步到该仓库。

入门指南

访问我们的文档以了解更多关于 Convex 的信息，并遵循我们的入门指南。

构建 Convex 应用最简单的方式是通过我们的云平台，它包含一个慷慨的免费层级，让你可以专注于构建你的应用，而无需担心基础设施。许多小型应用和副项目可以完全在免费层级上运行，无需任何费用和维护。

自托管

自托管产品包括云产品的大部分功能，包括仪表板和 CLI。自托管的 Convex 可与多种工具（如 Neon、Fly.io、Vercel、Netlify、RDS、Sqlite、Postgres 等）很好地配合使用。

你可以使用 Docker（推荐）或预构建的二进制文件来自托管 Convex。查看我们的自托管指南以获取详细说明。自托管的社区支持可在 Discord 的 #self-hosted 频道中获得。

社区与支持

• 加入我们的 Discord 社区 获取帮助和讨论。
• 在使用开源 Convex 后端时遇到的问题，请通过 GitHub Issues 报告。

从源码构建

参见 BUILD.md。

免责声明

• 如果你选择自托管，我们建议遵循自托管指南。如果你选择从源码构建，请确保更改你的实例密钥和管理密钥，而不是使用仓库中的默认值。
• Convex 在 Linux 和 Mac 上经过了最严格的测试。在 Windows 上，它的经验较少。如果你遇到问题，请在 Discord 的 #self-hosted 频道中联系我们。
• Convex 自托管构建包含一个信标，用于帮助 Convex 改进产品。这些信息是匿名且最小化的，对 Convex 有帮助，但如果你真的想禁用它，可以在后端二进制文件上设置 --disable-beacon 标志。信标的信息会打印在日志中，仅包括：
  • 一个随机标识符（用于你的部署，不用于其他用途）
  • 你的数据库的迁移版本
  • 后端的 Git 修订版本
  • 后端的运行时间

仓库布局

• crates/ 包含 Rust 代码
  • 主要二进制文件
    • local_backend/ 是 Runtime 之上的应用服务器。它是 Convex 云服务的服务端。
• npm-packages/ 包含我们的公共和内部 TypeScript 包。
  • 内部包
    • udf-runtime/ 为用户定义的函数设置 JavaScript 环境，用于查询和变更。
    • udf-tests/ 是一组用于测试隔离层的函数集合。
    • system-udfs/ 包含由 Convex 系统使用的函数，例如 CLI。