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 — это открытая реактивная база данных, которая позволяет разработчикам веб-приложений получать данные и выполнять бизнес-логику с высокой согласованностью, написав всё на чистом TypeScript вместо самостоятельной сборки бэкенда.
Это база данных, которую я запускаю сам, или облачный сервис?И то, и другое: проще всего использовать управляемую облачную платформу Convex, но этот репозиторий также позволяет развернуть весь бэкенд у себя (вместе с панелью управления и CLI) через Docker или готовый бинарный файл.
Как начать работу с Convex?Для облачной платформы следуйте руководствам по началу работы в документации. Чтобы развернуть у себя, запустите бэкенд через Docker (рекомендуется) или готовый бинарный файл, следуя руководству по развертыванию у себя.
Что нужно, чтобы развернуть Convex у себя?Для запуска бэкенда нужны Docker или готовый бинарный файл. Он также интегрируется с внешними провайдерами хранения данных, такими как Neon, Fly.io, Vercel, Netlify, RDS, Sqlite или Postgres.
Одинаково ли надежен Convex, развернутый у себя, на всех ОС?Лучше всего он проверен в боевых условиях на Linux и Mac; поддержка Windows менее зрелая. Если собирать из исходников, а не использовать опубликованные бинарные файлы, нужно вручную изменить секрет экземпляра по умолчанию и ключ администратора.
Связывается ли развернутый у себя бэкенд с разработчиками?Да, сборки для развертывания у себя отправляют анонимный сигнал со случайным идентификатором развертывания, версией миграции базы данных, ревизией git и временем работы. Его можно отключить флагом --disable-beacon.
Какой самый простой способ попробовать Convex без развертывания у себя?Используйте облачную платформу Convex, у которой есть щедрый бесплатный тариф, так что небольшие приложения и личные проекты могут работать без затрат и обслуживания.
На чем написан Convex внутри?Сам бэкенд (crates/) написан на Rust, а публичные и внутренние npm-пакеты, включая CLI и клиентские библиотеки, — на TypeScript.
Creator
convex
Size
187.3 MB
Stars
12.7K
Age
2y
Commits · 90 Days