mirror of
https://github.com/farcasclaudiu/Flowise.git
synced 2026-06-22 21:01:17 +03:00
Octavian FlowiseAI
957694a912
* transition GET /api/v1/apikey * transition POST /api/v1/apikey * transition PUT /api/v1/apikey/:id * transition DELETE /api/v1/apikey/:id * Enable e2e tests for api/v1/apikey routes * remove unused addChatflowsCount * Enable e2e tests for api/v1/variables routes * Enable Cypress in GitHub Action * Update main.yml * Update main.yml * Transition GET /api/v1/variables * Enable cypress on github workflow * Transition POST /api/v1/variables * Transition PUT /api/v1/variables * Transition DELETE /api/v1/variables * Transition GET /api/v1/variables * Transition GET /api/v1/chatflows * Transition GET /api/v1/chatflows/:id * Transition POST /api/v1/chatflows * Transition DELETE /api/v1/chatflows/:id * Transition PUT /api/v1/chatflows/:id * Transition GET /api/v1/chatflows/apikey/:apiKey * Transition GET /api/v1/credentials * Transition POST /api/v1/credentials * Transition GET /api/v1/credentials/:id * Transition PUT /api/v1/credentials/:id * Transition DELETE /api/v1/credentials/:id * Transition GET /api/v1/tools * Transition GET /api/v1/tools/:id * Transition POST /api/v1/tools * Transition PUT & DELETE /api/v1/tools/:id * Transition /api/v1/assistants routes * Transition /api/v1/nodes routes * Transition GET /api/v1/chatflows-streaming/:id & GET /api/v1/chatflows-uploads/:id * wip-all-routes * Transition GET /api/v1/public-chatflows/:id & /api/v1/public-chatbotConfig/:id * Remove ts-ignore annotations * Transition GET /api/v1/chatmessage/:id * Transition POST /api/v1/chatmessage/:id * delete /api/v1/chatmessage/:id * transition /api/v1/feedback/:id routes * transition /api/v1/stats/:id * Transition GET /api/v1/openai-assistants/:id * Transition GET /api/v1/openai-assistants * Transition POST /api/v1/openai-assistants-file * transition GET /api/v1/get-upload-path * transition GET /api/v1/get-upload-file * transition GET /api/v1/flow-config/:id * transition POST /api/v1/node-config * transition GET /api/v1/version * transition GET /api/v1/fetch-links * transition POST /api/v1/vector/upsert/:id * transition POST /api/v1/vector/internal-upsert/:id * transition POST /api/v1/load-prompt * Update index.ts * transition POST /api/v1/prompts-list * transition predictions * Update index.ts * transition GET /api/v1/marketplaces/templates * Router update modularity cleanup * extend request interface - express namespace * Update index.ts * add errorMiddleware * Add custom application error handler * Fix pnpm lock file * prediction return and vector upsert * Move the getUploadsConfig into its own file * Remove lint warnings * fix undefined variable value * Fix node-load-method api call * standardize the error message display * Apply review comment bugfixes * Update index.ts * standardize error message display in snack notifications * Error message standard in the UI * Rename flowXpressApp to appServer * Upload middleware fix and axios update * fix async await --------- Co-authored-by: Henry <hzj94@hotmail.com>
94 lines
2.5 KiB
Markdown
94 lines
2.5 KiB
Markdown
<!-- markdownlint-disable MD030 -->
|
|
|
|
# Flowise - Low-Code LLM apps builder
|
|
|
|
English | [中文](./README-ZH.md)
|
|
|
|
|
|
|
|
Drag & drop UI to build your customized LLM flow
|
|
|
|
## ⚡Quick Start
|
|
|
|
1. Install Flowise
|
|
```bash
|
|
npm install -g flowise
|
|
```
|
|
2. Start Flowise
|
|
|
|
```bash
|
|
npx flowise start
|
|
```
|
|
|
|
3. Open [http://localhost:3000](http://localhost:3000)
|
|
|
|
## 🔒 Authentication
|
|
|
|
To enable app level authentication, add `FLOWISE_USERNAME` and `FLOWISE_PASSWORD` to the `.env` file:
|
|
|
|
```
|
|
FLOWISE_USERNAME=user
|
|
FLOWISE_PASSWORD=1234
|
|
```
|
|
|
|
## 🌱 Env Variables
|
|
|
|
Flowise support different environment variables to configure your instance. You can specify the following variables in the `.env` file inside `packages/server` folder. Read [more](https://github.com/FlowiseAI/Flowise/blob/main/CONTRIBUTING.md#-env-variables)
|
|
|
|
You can also specify the env variables when using `npx`. For example:
|
|
|
|
```
|
|
npx flowise start --PORT=3000 --DEBUG=true
|
|
```
|
|
|
|
## 📖 Tests
|
|
|
|
We use [Cypress](https://github.com/cypress-io) for our e2e testing. If you want to run the test suite in dev mode please follow this guide:
|
|
|
|
```sh
|
|
cd Flowise/packages/server
|
|
pnpm install
|
|
./node_modules/.bin/cypress install
|
|
pnpm build
|
|
#Only for writting new tests on local dev -> pnpm run cypress:open
|
|
pnpm run e2e
|
|
```
|
|
|
|
## 📖 Documentation
|
|
|
|
[Flowise Docs](https://docs.flowiseai.com/)
|
|
|
|
## 🌐 Self Host
|
|
|
|
### [Railway](https://docs.flowiseai.com/deployment/railway)
|
|
|
|
[](https://railway.app/template/YK7J0v)
|
|
|
|
### [Render](https://docs.flowiseai.com/deployment/render)
|
|
|
|
[](https://docs.flowiseai.com/deployment/render)
|
|
|
|
### [AWS](https://docs.flowiseai.com/deployment/aws)
|
|
|
|
### [Azure](https://docs.flowiseai.com/deployment/azure)
|
|
|
|
### [DigitalOcean](https://docs.flowiseai.com/deployment/digital-ocean)
|
|
|
|
### [GCP](https://docs.flowiseai.com/deployment/gcp)
|
|
|
|
## 💻 Cloud Hosted
|
|
|
|
Coming Soon
|
|
|
|
## 🙋 Support
|
|
|
|
Feel free to ask any questions, raise problems, and request new features in [discussion](https://github.com/FlowiseAI/Flowise/discussions)
|
|
|
|
## 🙌 Contributing
|
|
|
|
See [contributing guide](https://github.com/FlowiseAI/Flowise/blob/master/CONTRIBUTING.md). Reach out to us at [Discord](https://discord.gg/jbaHfsRVBW) if you have any questions or issues.
|
|
|
|
## 📄 License
|
|
|
|
Source code in this repository is made available under the [Apache License Version 2.0](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md).
|