Npx Y Convex@latest MCP Start

🚀 Convex Database

Convex is an open-source reactive database designed to simplify web application development for both human developers and LLMs (Large Language Models). You can fetch data and implement business logic by writing pure TypeScript code, which runs with strong consistency guarantees. Convex offers a database, an environment for executing server functions, and a client library. It makes it easy to build and scale applications with dynamic real-time updates. Read the documentation for more information.

The development of the Convex backend is led by the Convex team. We welcome any bug fixes and are happy to receive feedback. We synchronize this repository with our internal development work at intervals of no more than a few days.

🚀 Quick Start

Visit our documentation to learn more about Convex and follow the getting-started guide.

The easiest way to build applications is by using the Convex Cloud Platform, which includes a generous free tier so you don't have to worry about infrastructure. Many small applications and side projects can run completely for free without maintenance.

📦 Self-Hosting

The self-hosted version includes most features from the cloud product, such as dashboards and CLI tools. Self-hosted Convex is compatible with various tools, including Neon, Fly.io, Vercel, Netlify, RDS, Sqlite, and Postgres.

You can self-host Convex using Docker (recommended) or pre-compiled binaries. Check out our Self-Hosting Guide for detailed instructions. Community support for self-hosting is available in the #self-hosted channel on Discord.

👥 Community and Support

• Join our Discord community for help and discussions.
• Report any issues you encounter when using the open-source Convex backend via GitHub issues.

🛠️ Building from Source

See BUILD.md.

⚠️ Disclaimer

• If you choose to self-host, follow the self-hosting guide. If you're building from source, ensure you change the instance key and admin key and don't use the default values in the repository.
• Convex has been most comprehensively tested on Linux and Mac. There is less experience on Windows. If you encounter issues, contact us in the #self-hosted channel on Discord.
• The self-hosted version of Convex includes a beacon to help Convex improve the product. The information is minimal and anonymous, and it's helpful to Convex, but if you really want to disable it, set the --disable-beacon flag on the backend binary. The beacon's log output includes:
  • A random identifier for your deployment (not used elsewhere)
  • The database migration version
  • The Git version of the backend
  • The runtime of the backend

📁 Repository Structure

• crates/ contains Rust code
  • Main binaries
    • local_backend/ is an application server based on Runtime for the Convex cloud service.
• npm-packages/ contains public and internal TypeScript packages.
  • Internal packages
    • udf-runtime/ sets up the JavaScript runtime environment for user-defined functions (UDFs) to execute business logic.
    • udf-cli/ provides command-line tools related to UDF execution.