convex-backend README

The project's README from github.com/convex/convex-backend. As one markdown file: README.md.

Convex logo

Convex is the open-source reactive database designed to make life easy for web app developers, whether human or LLM. Fetch data and perform business logic with strong consistency by writing pure TypeScript.

Convex provides a database, a place to write your server functions, and client libraries. It makes it easy to build and scale dynamic live-updating apps. Read the docs to learn more.

Development of the Convex backend is led by the Convex team. We welcome small bug fixes and love receiving feedback. We keep this repository synced with any internal development work within a handful of days. Convex is a well tested piece of software, with several well designed test frameworks including randomized testing. Those tests are not provided as part of the open source offering.

Getting Started

Visit our documentation to learn more about Convex and follow our getting started guides.

The easiest way to build with Convex is through our cloud platform, which includes a generous free tier and lets you focus on building your application without worrying about infrastructure. Many small applications and side-projects can operate entirely on the free tier with zero cost and zero maintenance.

Self Hosting

The self-hosted product includes most features of the cloud product, including the dashboard and CLI. Self-hosted Convex works well with a variety of tools including Neon, Fly.io, Vercel, Netlify, RDS, Sqlite, Postgres, and more.

You can either use Docker (recommended) or a prebuilt binary to self host Convex. Check out our self-hosting guide for detailed instructions. Community support for self-hosting is available in the #self-hosted channel on Discord.

Community & Support

Building from source

See BUILD.md.

Disclaimers

Repository layout

convex-backend (convex/convex-backend)

Searching Database…

这是什么?Convex 是一个开源的响应式数据库,让 Web 应用开发者通过编写纯 TypeScript 代码来获取数据并执行业务逻辑,同时保证强一致性,无需从零手写后端。
这是我自己运行的数据库,还是托管服务?两种都有:最简单的方式是使用 Convex 的托管云平台,但本仓库也允许你通过 Docker 或预编译的二进制文件自行部署完整后端(包括控制台和 CLI)。
我该如何开始使用 Convex?使用云平台的话,请按照文档中的入门指南操作。若要自行部署,请参照自部署指南,通过 Docker(推荐)或预编译的二进制文件运行后端。
自部署 Convex 需要准备什么?运行后端需要 Docker 或预编译的二进制文件,并且它可以对接外部存储服务,例如 Neon、Fly.io、Vercel、Netlify、RDS、Sqlite 或 Postgres。
自部署的 Convex 在各个操作系统上的稳定性都一样吗?它在 Linux 和 Mac 上经过了最充分的测试,Windows 的支持还不够成熟。另外,如果你是从源码构建而不是使用发布的二进制文件,就必须手动修改默认的实例密钥和管理员密钥。
自部署的后端会向外发送数据吗?会。自部署版本会发送一个匿名信标,包含随机部署 ID、数据库迁移版本、git 修订号和运行时长;你可以通过 --disable-beacon 参数将其关闭。
不自部署,最简单的试用 Convex 的方式是什么?使用 Convex 的云平台。它提供了较为慷慨的免费套餐,小型应用和业余项目可以零成本运行,也无需维护。
Convex 的底层是用什么语言编写的?后端本身(crates/ 目录)使用 Rust 编写,而包括 CLI 和客户端库在内的公共及内部 npm 包则使用 TypeScript 编写。
Creator
convex
Size
187.3 MB
Stars
12.7K
Age
2y
Commits · 90 Days