Convex constitutes an open-source data store framework architected to streamline the construction of responsive web applications, whether they serve human end-users or sophisticated AI agents. Data retrieval and execution of core operational logic are guaranteed with unwavering transactional integrity by utilizing plain TypeScript definitions.

This system encapsulates the necessary database components, a secure environment for authoring server-side routines, and comprehensive client SDKs. Its primary function is simplifying the creation and scalable deployment of applications featuring real-time data synchronization. Consult the official documentation for in-depth understanding.

The iterative refinement of the Convex data platform is overseen by the core Convex engineering collective. We actively solicit contributions for defect resolution and highly value any user-provided insights. This repository is maintained in close synchronization with internal engineering progress, usually within a few days.

Initiating Development

Navigate to our documentation portal to explore the platform capabilities and follow the initial setup tutorials.

The most friction-free path to integration involves leveraging our cloud hosting service, which features a substantial complimentary usage tier, allowing architects to concentrate solely on application functionality without infrastructure overhead. Numerous smaller projects and personal endeavors can operate indefinitely within this free tier without incurring costs or maintenance obligations.

On-Premise Deployment

The self-hosted offering mirrors the majority of features present in the cloud deployment, including the administrative console and command-line interface. Self-managed Convex integrates smoothly with diverse persistence providers such as Neon, Fly.io, Vercel, Netlify, RDS, Sqlite, and PostgreSQL, among others.

Deployment is achievable either via containerization using Docker (the favored method) or by utilizing a compiled binary. Refer to our dedicated self-hosting procedural guide for step-by-step instructions. Community assistance for self-hosting issues is available via the #self-hosted channel on Discord.

Support Channels

Engage with our community for assistance and technical discussions on Discord.
Log any discovered anomalies during the development or usage of the open-source Convex backend through GitHub Issues

Compiling from Source

Review the instructions provided in BUILD.md.

Important Notices

If opting for self-hosting, adhere strictly to the self-hosting documentation. If compiling directly from source, ensure that the default deployment secret and administrative credentials within the repository are promptly replaced.
Convex functionality has been most rigorously validated across Linux and macOS environments. Support for Windows deployments is less mature. Should any irregularities arise, please contact us via Discord in the designated #self-hosted location.
Self-hosted Convex installations incorporate a subtle telemetry beacon to assist Convex in product enhancement. This transmission is minimal, anonymous, and aids in development diagnostics, but can be deactivated by invoking the --disable-beacon parameter when executing the backend binary.

Directory Structure

crates/ houses the codebase written in Rust.
Core Execution Engine
- local_backend/ functions as the application server layer sitting atop the core Runtime. This component serves as the primary network interface point for the Convex cloud infrastructure.
npm-packages/ contains all our publicly exposed and internally utilized TypeScript modules.
Internal Utility Modules
- udf-runtime/ establishes the JavaScript execution sandbox utilized for running user-defined database queries and modification functions.
- udf-tests/ includes a repository of utility functions employed in validating the isolation layer for user functions.
- system-udfs/ houses essential functions invoked internally by the Convex system, such as CLI operations.