Skip to main content

Contribute to Langflow

This guide is intended to help you start contributing to Langflow. As an open-source project in a rapidly developing field, Langflow welcomes contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.

To contribute code or documentation to this project, follow the fork and pull request workflow.

Contribute code​

Develop Langflow locally with uv and Node.js.

Prerequisites​

Clone the Langflow Repository​

  1. Navigate to the Langflow GitHub repository, and then click Fork.

  2. Add the new remote to your local repository on your local machine: Replace YOUR_FORK_NAME with a name for your fork. Replace YOUR_GIT_USERNAME with your Git username.


_10
git remote add YOUR_FORK_NAME https://github.com/YOUR_GIT_USERNAME/langflow.git

Prepare the development environment​

  1. Create development hooks.

_10
make init

This command sets up the development environment by installing backend and frontend dependencies, building the frontend static files, and initializing the project. It runs make install_backend, make install_frontend, make build_frontend, and finally uv run langflow run to start the application.

  1. Run make lint, make format, and make unit_tests before pushing to the repository.

Debug​

The repo includes a .vscode/launch.json file for debugging the backend in VSCode, which is faster than debugging with Docker Compose. To debug Langflow with the launch.json file in VSCode:

  1. Open Langflow in VSCode.
  2. Press Ctrl+Shift+D for Windows or Cmd+Shift+D for Mac to open the Run and Debug view.
  3. From the Run and Debug dropdown, choose a debugging configuration.
  4. Click the green Play button or press F5 to start debugging.

Use launch.json to quickly debug different parts of your application, like the backend, frontend, or CLI, directly from VSCode.

Run Langflow locally​

After setting up the environment with make init, you can run Langflow's backend and frontend separately for development.

Before you begin, ensure you have uv and Node.js installed.

  1. In the repository root, install the dependencies and start the development server for the backend:

_10
make backend

  1. Install dependencies and start the frontend:

_10
make frontend

This approach allows you to work on the backend and frontend independently, with hot-reloading for faster development.

Contribute documentation​

The documentation is built using Docusaurus and written in Markdown.

Prerequisites​

Clone the Langflow repository​

  1. Navigate to the Langflow GitHub repository, and then click Fork.

  2. Add the new remote to your local repository on your local machine:


_10
git remote add fork https://github.com/<your_git_username>/langflow.git

  1. To run the documentation locally, run the following commands:

_10
cd docs
_10
yarn install
_10
yarn start

The documentation will be available at localhost:3000 and all the files are located in the docs/docs folder.

Open a pull request​

Once you have written and manually tested your changes with make lint and make unit_tests, open a pull request to send your changes upstream to the main Langflow repository.

  1. Open a new GitHub pull request with your patch against the main branch.
  2. Ensure the PR title follows semantic commit conventions. For example, features are feat: add new feature and fixes are fix: correct issue with X.
  3. A Langflow maintainer will review your pull request. Thanks for your contribution!

Some additional guidance on pull request titles:

  • Ensure the pull request description clearly describes the problem and solution. If the PR fixes an issue, include a link to the fixed issue in the PR description with Fixes #1234.
  • Pull request titles appear in Langflow's release notes, so they should explain what the PR does as explicitly as possible.
  • Pull requests should strive to fix one thing only, and should contain a good description of what is being fixed.

For more information, see the Python Developer's Guide.

Additional contribution guides​

Search