Spaces:
Configuration error
Configuration error
Commit ·
9612721
1
Parent(s): ecaa7fc
Update .gitattributes
Browse files
README.md
DELETED
|
@@ -1,160 +0,0 @@
|
|
| 1 |
-
<!-- markdownlint-disable MD030 -->
|
| 2 |
-
|
| 3 |
-
# Flowise - LangchainJS UI
|
| 4 |
-
|
| 5 |
-
<a href="https://github.com/FlowiseAI/Flowise">
|
| 6 |
-
<img width="100%" src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true"></a>
|
| 7 |
-
|
| 8 |
-
Drag & drop UI to build your customized LLM flow using [LangchainJS](https://github.com/hwchase17/langchainjs)
|
| 9 |
-
|
| 10 |
-
## ⚡Quick Start
|
| 11 |
-
|
| 12 |
-
Download and Install [NodeJS](https://nodejs.org/en/download) >= 18.15.0
|
| 13 |
-
|
| 14 |
-
1. Install Flowise
|
| 15 |
-
```bash
|
| 16 |
-
npm install -g flowise
|
| 17 |
-
```
|
| 18 |
-
2. Start Flowise
|
| 19 |
-
|
| 20 |
-
```bash
|
| 21 |
-
npx flowise start
|
| 22 |
-
```
|
| 23 |
-
|
| 24 |
-
With username & password
|
| 25 |
-
|
| 26 |
-
```bash
|
| 27 |
-
npx flowise start --FLOWISE_USERNAME=user --FLOWISE_PASSWORD=1234
|
| 28 |
-
```
|
| 29 |
-
|
| 30 |
-
3. Open [http://localhost:3000](http://localhost:3000)
|
| 31 |
-
|
| 32 |
-
## 🐳 Docker
|
| 33 |
-
|
| 34 |
-
### Docker Compose
|
| 35 |
-
|
| 36 |
-
1. Go to `docker` folder at the root of the project
|
| 37 |
-
2. Create `.env` file and specify the `PORT` (refer to `.env.example`)
|
| 38 |
-
3. `docker-compose up -d`
|
| 39 |
-
4. Open [http://localhost:3000](http://localhost:3000)
|
| 40 |
-
5. You can bring the containers down by `docker-compose stop`
|
| 41 |
-
|
| 42 |
-
### Docker Image
|
| 43 |
-
|
| 44 |
-
1. Build the image locally:
|
| 45 |
-
```bash
|
| 46 |
-
docker build --no-cache -t flowise .
|
| 47 |
-
```
|
| 48 |
-
2. Run image:
|
| 49 |
-
|
| 50 |
-
```bash
|
| 51 |
-
docker run -d --name flowise -p 3000:3000 flowise
|
| 52 |
-
```
|
| 53 |
-
|
| 54 |
-
3. Stop image:
|
| 55 |
-
```bash
|
| 56 |
-
docker stop flowise
|
| 57 |
-
```
|
| 58 |
-
|
| 59 |
-
## 👨💻 Developers
|
| 60 |
-
|
| 61 |
-
Flowise has 3 different modules in a single mono repository.
|
| 62 |
-
|
| 63 |
-
- `server`: Node backend to serve API logics
|
| 64 |
-
- `ui`: React frontend
|
| 65 |
-
- `components`: Langchain components
|
| 66 |
-
|
| 67 |
-
### Prerequisite
|
| 68 |
-
|
| 69 |
-
- Install Yarn
|
| 70 |
-
```bash
|
| 71 |
-
npm i -g yarn
|
| 72 |
-
```
|
| 73 |
-
|
| 74 |
-
### Setup
|
| 75 |
-
|
| 76 |
-
1. Clone the repository
|
| 77 |
-
|
| 78 |
-
```bash
|
| 79 |
-
git clone https://github.com/FlowiseAI/Flowise.git
|
| 80 |
-
```
|
| 81 |
-
|
| 82 |
-
2. Go into repository folder
|
| 83 |
-
|
| 84 |
-
```bash
|
| 85 |
-
cd Flowise
|
| 86 |
-
```
|
| 87 |
-
|
| 88 |
-
3. Install all dependencies of all modules:
|
| 89 |
-
|
| 90 |
-
```bash
|
| 91 |
-
yarn install
|
| 92 |
-
```
|
| 93 |
-
|
| 94 |
-
4. Build all the code:
|
| 95 |
-
|
| 96 |
-
```bash
|
| 97 |
-
yarn build
|
| 98 |
-
```
|
| 99 |
-
|
| 100 |
-
5. Start the app:
|
| 101 |
-
|
| 102 |
-
```bash
|
| 103 |
-
yarn start
|
| 104 |
-
```
|
| 105 |
-
|
| 106 |
-
You can now access the app on [http://localhost:3000](http://localhost:3000)
|
| 107 |
-
|
| 108 |
-
6. For development build:
|
| 109 |
-
|
| 110 |
-
```bash
|
| 111 |
-
yarn dev
|
| 112 |
-
```
|
| 113 |
-
|
| 114 |
-
Any code changes will reload the app automatically on [http://localhost:8080](http://localhost:8080)
|
| 115 |
-
|
| 116 |
-
## 🔒 Authentication
|
| 117 |
-
|
| 118 |
-
To enable app level authentication, add `FLOWISE_USERNAME` and `FLOWISE_PASSWORD` to the `.env` file in `packages/server`:
|
| 119 |
-
|
| 120 |
-
```
|
| 121 |
-
FLOWISE_USERNAME=user
|
| 122 |
-
FLOWISE_PASSWORD=1234
|
| 123 |
-
```
|
| 124 |
-
|
| 125 |
-
## 📖 Documentation
|
| 126 |
-
|
| 127 |
-
[Flowise Docs](https://docs.flowiseai.com/)
|
| 128 |
-
|
| 129 |
-
## 🌐 Self Host
|
| 130 |
-
|
| 131 |
-
### [Railway](https://docs.flowiseai.com/deployment/railway)
|
| 132 |
-
|
| 133 |
-
[](https://railway.app/template/YK7J0v)
|
| 134 |
-
|
| 135 |
-
### [Render](https://docs.flowiseai.com/deployment/render)
|
| 136 |
-
|
| 137 |
-
[](https://docs.flowiseai.com/deployment/render)
|
| 138 |
-
|
| 139 |
-
### [AWS](https://docs.flowiseai.com/deployment/aws)
|
| 140 |
-
|
| 141 |
-
### [DigitalOcean](https://docs.flowiseai.com/deployment/digital-ocean)
|
| 142 |
-
|
| 143 |
-
### [GCP](https://docs.flowiseai.com/deployment/gcp)
|
| 144 |
-
|
| 145 |
-
## 💻 Cloud Hosted
|
| 146 |
-
|
| 147 |
-
Coming soon
|
| 148 |
-
|
| 149 |
-
## 🙋 Support
|
| 150 |
-
|
| 151 |
-
Feel free to ask any questions, raise problems, and request new features in [discussion](https://github.com/FlowiseAI/Flowise/discussions)
|
| 152 |
-
|
| 153 |
-
## 🙌 Contributing
|
| 154 |
-
|
| 155 |
-
See [contributing guide](CONTRIBUTING.md). Reach out to us at [Discord](https://discord.gg/jbaHfsRVBW) if you have any questions or issues.
|
| 156 |
-
[](https://star-history.com/#FlowiseAI/Flowise&Date)
|
| 157 |
-
|
| 158 |
-
## 📄 License
|
| 159 |
-
|
| 160 |
-
Source code in this repository is made available under the [MIT License](LICENSE.md).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|