Npx Y convex@latest mcp start

Convex は、人間にも LLM にも、Web アプリ開発者が簡単に開発できるよう設計されたオープンソースのリアクティブデータベースです。純粋な TypeScript を記述することで、強い一貫性を保ちながらデータを取得し、ビジネスロジックを実行できます。

Convex は、データベース、サーバー関数を記述する場所、クライアントライブラリを提供します。動的でリアルタイムに更新されるアプリを簡単に構築し、スケールできます。 ドキュメントを読んで詳細をご確認ください。

Convex バックエンドの開発は Convex チームが主導しています。 小規模なバグ修正を歓迎し、 フィードバックをお待ちしています。このリポジトリには、社内での開発作業が数日以内に反映されます。Convex は、ランダム化テストを含む、複数の適切に設計されたテストフレームワークで十分にテストされたソフトウェアです。これらのテストはオープンソース版には含まれていません。

はじめに

ドキュメントをご覧になり、Convex の詳細を確認して、導入ガイドに沿って進めてください。

Convex を使って開発する最も簡単な方法は、 クラウドプラットフォームを利用することです。充実した無料プランが用意されており、インフラストラクチャを気にせずアプリケーションの開発に集中できます。小規模なアプリケーションや個人プロジェクトの多くは、費用もメンテナンスも一切かけずに無料プランだけで運用できます。

セルフホスト

セルフホスト版には、ダッシュボードや CLI など、クラウド版のほとんどの機能が含まれています。セルフホスト版の Convex は、Neon、Fly.io、Vercel、Netlify、RDS、Sqlite、Postgres など、さまざまなツールと連携できます。

Docker（推奨）またはビルド済みバイナリを使って Convex をセルフホストできます。詳しい手順については、セルフホストガイドをご覧ください。セルフホストに関するコミュニティサポートは、Discord の #self-hosted チャンネルで利用できます。

コミュニティとサポート

• サポートや意見交換には、Discord コミュニティにご参加ください。
• オープンソース版の Convex バックエンドの構築や使用中に発生した問題は、GitHub Issuesから報告してください。
• プルリクエストを送信することで、Convex が選択する条件のもとで、その貢献を使用、変更、複製、再配布できることに同意したものとみなされます。

ソースからビルドする

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 環境をセットアップします
    • system-udfs/ には、CLI など、Convex システムで使用される関数が含まれています