コントリビューター向けセットアップ

要件

• Git (必須)
• Node.js v24.16.0 (必須)
• npm v11.16.0 (必須)
• MongoDB (必須、データベース用)
• Git LFS (大きなファイルに便利)
• GitHub Desktop (オプション)
• VSCode （推奨されるソースコードエディタ）

推奨されるVSCode拡張機能

VS Codeに以下の拡張機能をインストールしてください：

• Prettier
• ESLint
• GitLens

環境の準備

Node.js と npm

nvm を使用している場合は、LibreChat をインストールする前に、推奨される Node.js バージョンをインストールして選択してください：

nvm install 24.16.0
nvm use 24.16.0
npm install -g [email protected]

シェルが期待されるバージョンを使用していることを確認してください：

node -v
npm -v

v24.16.0
11.16.0

GitHub

• LibreChat リポジトリをフォークします: https://github.com/danny-avila/LibreChat/fork

• フォーク上にブランチを作成し、適切な名前を付け、元のリポジトリにリンクしてください。

• 新しいブランチをローカルPCにダウンロードします

git clone -b branch-name https://github.com/username/LibreChat.git

branch-name と username をご自身の詳細情報に置き換えてください。

VS Codeで開く

• ブランチをクローンした後：

  cd LibreChat

  code .

LibreChatの準備

• VS Codeでターミナルを開くには、ctrl+shift+` を押します。

  または、ctrl+j を使用して下部ペインを開き、ターミナルを選択します。

• npm run smart-reinstall

  Node.jsやnpmのバージョンを変更したばかりの場合は、クリーンインストールを行うために一度 npm run reinstall を実行してください。

• npm run build

• .env 設定

  • .env ファイルを作成します。まだ作成していない場合は、.env.example を複製して設定を行ってください。

開発ワークフロー

LibreChatで効率的に作業するには、以下のコマンドを使用してください：

• バックエンドの起動:

  • 通常の操作には npm run backend を使用してください。
  • アクティブな開発を行うには、npm run backend:dev を使用して変更を監視してください。
  • http://localhost:3080/ にアクセスします。

• フロントエンドを開発モードで実行する:

  • バックエンドが実行されていることを確認してください。
  • npm run frontend:dev を使用して、フロントエンドの変更を監視します。
  • http://localhost:3090/ で表示します。

ローカルテスト

送信前に、ローカルで更新内容をテストしてください。詳細は Perform Tests Locally を参照してください。

テストを実行することで、コントリビューションが堅牢であり、統合の準備が整っていることを確認してください。

コミット、プッシュ、プルリクエスト (PR)

コミットを作成する

Commits は、開発における論理的なチェックポイントを示します。変更内容を説明する明確なメッセージを含めてください。

例:

git add .
git commit -m "Add login functionality"

変更をプッシュする

機能の実装や問題の修正が完了したら、変更をリモートリポジトリに Push してください。

例:

git push origin feature-branch-name

Pull Request (PR) を作成する

Pull Requestは、機能ブランチからメインブランチへ変更をマージします。

1. mainブランチから最新の変更をプルし、競合を解決します。
2. 更新されたフィーチャーブランチをプッシュします。
3. コードがプロジェクトのガイドラインに従っていることを確認してください。

例:

git checkout main
git pull origin main
git checkout feature-branch-name
git rebase main
# Resolve conflicts if any
git push origin feature-branch-name
# Open PR on GitHub

ブラウザでリポジトリにアクセスし、「Contribute」をクリックしてください。

コミットを安全にリバートする

機能ブランチでの変更を取り消すには、慎重に以下の手順に従ってください：

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  削除するコミットの pick を drop に置き換えます。エディタを保存して終了します。

• git push --force-with-lease origin feature-branch-name