概要
生産的なLibreChat開発ワークフローを構築する方法。
Dockerはほとんどのユーザーにとって推奨されるインストール方法ですが、LibreChatのローカル開発にはnpmを使用する必要があります。アプリをマシン上で直接実行することで、より高速なフィードバック、より明確なデバッグが可能になり、変更のたびにコンテナを再ビルドすることなくmonorepoワークスペースに直接アクセスできるようになります。
推奨ツールチェーン
npmベースの開発には、このツールチェーンを使用してください:
| ツール | バージョン |
|---|---|
| Node.js | v24.16.0 |
| npm | v11.16.0 |
| MongoDB | Atlas または Community Server |
Node 24は、ESM専用パッケージとのCommonJS相互運用性、WebCrypto、およびFetch APIに関するLibreChatのランタイム要件を満たしています。お使いのシェルで古いNodeバージョンが表示される場合は、依存関係をインストールする前に、LibreChatリポジトリから nvm use 24.16.0 を実行してください。
適切なワークスペースで作業する
LibreChatはモノレポです。変更を加える動作を管理している最小のワークスペースを選択してください:
| Workspace | 用途 |
|---|---|
/packages/api | 新しいバックエンドのTypeScriptサービス、コントローラー、および共有サーバーロジック |
/api | レガシーなExpressサーバー統合。変更は最小限に留めること |
/packages/data-schemas | データベースモデル、スキーマ、およびデータベース固有の共有ロジック |
/packages/data-provider | 共有API型、endpoint、クエリキー、およびデータサービス関数 |
/client | Reactアプリケーションコード |
/packages/client | 共有フロントエンドユーティリティ |
日次コマンド
| コマンド | 目的 |
|---|---|
npm run smart-reinstall | 必要に応じて依存関係をインストールし、コンパイルされたワークスペースをビルドする |
npm run reinstall | Node/npmのバージョン変更後や、依存関係の状態が疑わしい場合にクリーンインストールを行う |
npm run backend:dev | ファイル監視を有効にしてバックエンドを起動する |
npm run frontend:dev | ポート 3090 でフロントエンド開発サーバーを起動する |
npm run build:data-provider | API/型の変更後に共有のdata-providerコードを再ビルドする |
npm run build | Turborepoを通じてすべてのコンパイル済みワークスペースをビルドする |
開発リソース
開発リソース
- リポジトリ、フォーク、ブランチ、プルリクエストが初めての方は、まず GitHubの共同開発ガイド から始めてください。
- PRを作成する前に、Contributor Guidelines をお読みください。
- 完全なローカルセットアップフローについては、Contributor Setup を使用してください。
- ワークスペースの境界、インポート順序、型定義、テスト、およびフロントエンドのルールについては、Code Standards and Conventions を使用してください。
このガイドはいかがでしたか?