Contributor Setup

Requirements

• Git (Essential)
• Node.js v24.16.0 (Essential)
• npm v11.16.0 (Essential)
• MongoDB (Essential, for the database)
• Git LFS (Useful for larger files)
• GitHub Desktop (Optional)
• VSCode (Recommended Source-code Editor)

Recommended VSCode Extensions

Install these extensions in VS Code:

• Prettier
• ESLint
• GitLens

Prepare the Environment

Node.js and npm

If you use nvm, install and select the recommended Node.js version before installing LibreChat:

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

Verify your shell is using the expected versions:

node -v
npm -v

v24.16.0
11.16.0

GitHub

• Fork the LibreChat repository: https://github.com/danny-avila/LibreChat/fork

• Create a branch on your fork, name it properly, and link it to the original repository.

• Download your new branch to your local PC

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

Replace branch-name and username with your details

Open in VS Code

• After cloning your branch:

  cd LibreChat

  code .

Prepare LibreChat

• Open the terminal in VS Code with ctrl+shift+`` ```

  Alternatively, use ctrl+j to open the bottom pane and select the terminal.

• npm run smart-reinstall

  If you just changed Node.js or npm versions, use npm run reinstall once for a clean install.

• npm run build

• .env Configuration

  • Create the .env file. If you don't have one, duplicate .env.example and configure it.

Development Workflow

For efficient work on LibreChat, use these commands:

• Starting Backend:

  • Use npm run backend for normal operation.
  • For active development, use npm run backend:dev to monitor changes.
  • Access at http://localhost:3080/.

• Running Frontend in Development Mode:

  • Ensure backend is running.
  • Use npm run frontend:dev to monitor frontend changes.
  • View at http://localhost:3090/.

Local Testing

Before submission, test your updates locally, see: Perform Tests Locally

By running tests, ensure your contributions are robust and ready for integration.

Commit, Push, Pull Request (PR)

Make a Commit

Commits mark logical checkpoints in development. Include clear messages explaining changes.

Example:

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

Push Changes

Push changes to the remote repository after completing a feature or fixing an issue.

Example:

git push origin feature-branch-name

Create a Pull Request (PR)

Pull Request merges changes from a feature branch into the main branch.

1. Pull latest changes from main branch and resolve conflicts.
2. Push updated feature branch.
3. Ensure code follows project guidelines.

Example:

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

Access your repository in a browser and click "Contribute".

Revert Commits Safely

To undo changes in a feature branch, follow these steps cautiously:

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  Replace pick with drop for commits to remove. Save and exit editor.

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