jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Added a TOC, consolidated content into 'intro' section, moved sections around for readability

Browse source
This commit is contained in:
SonicDMG 2024-05-22 14:09:26 -04:00
commit e0348017bc
1 changed files with 46 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

81
README.md
View file

@ -3,11 +3,19 @@
# [![Langflow](./docs/static/img/hero.png)](https://www.langflow.org) # [![Langflow](./docs/static/img/hero.png)](https://www.langflow.org)
<p align="center"><strong> <p align="center"><strong>
Visually build, iterate, and deploy Gen-AI apps in minutes A visual framework for building Gen-AI and RAG apps with LangChain
</strong></p> </strong></p>
<p align="center" style="font-size: 12px;"> <p align="center" style="font-size: 12px;">
Open-source, 100% Python, fully customizable, LLM and vector store agnostic Open-source, Python-powered, fully customizable, LLM and vector store agnostic
</p> </p>
<p align="center" style="font-size: 12px;">
<a href="https://docs.langflow.org" style="text-decoration: underline;">Docs</a> -
<a href="https://discord.com/invite/EqksyE2EX9" style="text-decoration: underline;">Join our Discord</a> -
<a href="https://twitter.com/langflow_ai" style="text-decoration: underline;">Follow us on X</a> -
<a href="https://huggingface.co/spaces/Langflow/Langflow-Preview" style="text-decoration: underline;">Live demo</a>
</p>
<p align="center"> <p align="center">
<img src="https://img.shields.io/github/stars/langflow-ai/langflow"> <img src="https://img.shields.io/github/stars/langflow-ai/langflow">
<img src="https://img.shields.io/discord/1116803230643527710?label=Discord"> <img src="https://img.shields.io/discord/1116803230643527710?label=Discord">
@ -17,18 +25,21 @@
<img src="./docs/static/img/langflow_basic_howto.gif" alt="Your GIF" style="border: 3px solid #211C43;"> <img src="./docs/static/img/langflow_basic_howto.gif" alt="Your GIF" style="border: 3px solid #211C43;">
</p> </p>
# ⚡️ Documentation and Community # 📝 Content
- [Documentation](https://docs.langflow.org) - [Get Started](#-get-started)
- [Discord](https://discord.com/invite/EqksyE2EX9) - [Create Flows](#-create-flows)
- [Deploy](#deploy)
- [Command Line Interface (CLI)](#️-command-line-interface-cli)
- [Contribute](#-contribute)
# 📦 Installation # 📦 Get Started
You can install Langflow with pip: You can install Langflow with pip:
```shell ```shell
# Make sure you have Python 3.10 installed on your system. # Make sure you have Python 3.10 installed on your system.
# Install the pre-release version # Install the pre-release version (recommended for the latest updates)
python -m pip install langflow --pre --force-reinstall python -m pip install langflow --pre --force-reinstall
# or stable version # or stable version
@ -43,7 +54,7 @@ python -m langflow run
You can also preview Langflow in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow-Preview). [Clone the space using this link](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true), to create your own Langflow workspace in minutes. You can also preview Langflow in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow-Preview). [Clone the space using this link](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true), to create your own Langflow workspace in minutes.
# 🎨 Creating Flows # 🎨 Create Flows
Creating flows with Langflow is easy. Simply drag components from the sidebar onto the canvas and connect them to start building your application. Creating flows with Langflow is easy. Simply drag components from the sidebar onto the canvas and connect them to start building your application.
@ -59,6 +70,32 @@ from langflow.load import run_flow_from_json
results = run_flow_from_json("path/to/flow.json", input_value="Hello, World!") results = run_flow_from_json("path/to/flow.json", input_value="Hello, World!")
``` ```
# Deploy
## Deploy Langflow on Google Cloud Platform
Follow our step-by-step guide to deploy Langflow on Google Cloud Platform (GCP) using Google Cloud Shell. The guide is available in the [**Langflow in Google Cloud Platform**](GCP_DEPLOYMENT.md) document.
Alternatively, click the **"Open in Cloud Shell"** button below to launch Google Cloud Shell, clone the Langflow repository, and start an **interactive tutorial** that will guide you through the process of setting up the necessary resources and deploying Langflow on your GCP project.
[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/langflow-ai/langflow&working_dir=scripts/gcp&shellonly=true&tutorial=walkthroughtutorial_spot.md)
## Deploy on Railway
Use this template to deploy Langflow 1.0 Preview on Railway:
[![Deploy 1.0 Preview on Railway](https://railway.app/button.svg)](https://railway.app/template/UsJ1uB?referralCode=MnPSdg)
Or this one to deploy Langflow 0.6.x:
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/JMXEWp?referralCode=MnPSdg)
## Deploy on Render
<a href="https://render.com/deploy?repo=https://github.com/langflow-ai/langflow/tree/main">
<img src="https://render.com/images/deploy-to-render-button.svg" alt="Deploy to Render" />
</a>
# 🖥️ Command Line Interface (CLI) # 🖥️ Command Line Interface (CLI)
Langflow provides a command-line interface (CLI) for easy management and configuration. Langflow provides a command-line interface (CLI) for easy management and configuration.
@ -101,33 +138,7 @@ You can configure many of the CLI options using environment variables. These can
A sample `.env` file named `.env.example` is included with the project. Copy this file to a new file named `.env` and replace the example values with your actual settings. If you're setting values in both your OS and the `.env` file, the `.env` settings will take precedence. A sample `.env` file named `.env.example` is included with the project. Copy this file to a new file named `.env` and replace the example values with your actual settings. If you're setting values in both your OS and the `.env` file, the `.env` settings will take precedence.
# Deployment # 👋 Contribute
## Deploy Langflow on Google Cloud Platform
Follow our step-by-step guide to deploy Langflow on Google Cloud Platform (GCP) using Google Cloud Shell. The guide is available in the [**Langflow in Google Cloud Platform**](GCP_DEPLOYMENT.md) document.
Alternatively, click the **"Open in Cloud Shell"** button below to launch Google Cloud Shell, clone the Langflow repository, and start an **interactive tutorial** that will guide you through the process of setting up the necessary resources and deploying Langflow on your GCP project.
[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/langflow-ai/langflow&working_dir=scripts/gcp&shellonly=true&tutorial=walkthroughtutorial_spot.md)
## Deploy on Railway
Use this template to deploy Langflow 1.0 Preview on Railway:
[![Deploy 1.0 Preview on Railway](https://railway.app/button.svg)](https://railway.app/template/UsJ1uB?referralCode=MnPSdg)
Or this one to deploy Langflow 0.6.x:
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/JMXEWp?referralCode=MnPSdg)
## Deploy on Render
<a href="https://render.com/deploy?repo=https://github.com/langflow-ai/langflow/tree/main">
<img src="https://render.com/images/deploy-to-render-button.svg" alt="Deploy to Render" />
</a>
# 👋 Contributing
We welcome contributions from developers of all levels to our open-source project on GitHub. If you'd like to contribute, please check our [contributing guidelines](./CONTRIBUTING.md) and help make Langflow more accessible. We welcome contributions from developers of all levels to our open-source project on GitHub. If you'd like to contribute, please check our [contributing guidelines](./CONTRIBUTING.md) and help make Langflow more accessible.