Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): add instructions for running from a cloned repo #3072

Merged
merged 4 commits into from
Jul 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@

- [📝 Content](#-content)
- [📦 Get Started](#-get-started)
- [Running Langflow from a Cloned Repository](#-running-langflow-from-a-cloned-repository)
- [🎨 Create Flows](#-create-flows)
- [Deploy](#deploy)
- [DataStax Langflow](#datastax-langflow)
Expand All @@ -69,18 +70,45 @@ You can install Langflow with pip:
# Make sure you have >=Python 3.10 installed on your system.
python -m pip install langflow -U
```
Or

If you would like to install from your cloned repo, you can build and install Langflow's frontend and backend with:
Then, run Langflow with:

```shell
python -m langflow run
```

# Running Langflow from a Cloned Repository
paulosalvatore marked this conversation as resolved.
Show resolved Hide resolved

If you prefer to run Langflow from a cloned repository rather than installing it via pip, follow these steps:

1. **Clone the Repository**

First, clone the Langflow repository from GitHub:

```shell
git clone https://github.com/langflow-ai/langflow.git
```

Navigate into the cloned directory:

```shell
cd langflow
```

2. **Build and Install Dependencies**

To build and install Langflow’s frontend and backend, use the following commands:

```shell
make install_frontend && make build_frontend && make install_backend
```

Then, run Langflow with:
3. **Run Langflow**

Once the installation is complete, you can run Langflow with:
paulosalvatore marked this conversation as resolved.
Show resolved Hide resolved

```shell
python -m langflow run
poetry run python -m langflow run
```

# 🎨 Create Flows
Expand Down