diff --git a/README.md b/README.md index 09b9ec8ba8e..05888e63117 100644 --- a/README.md +++ b/README.md @@ -126,9 +126,9 @@ Flowise has 3 different modules in a single mono repository. 6. For development build: - - Create `.env` file and specify the `VITE_PORT` (refer to `.env.example`) in `packages/ui` - - Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/server` - - Run + - Create `.env` file and specify the `VITE_PORT` (refer to `.env.example`) in `packages/ui` + - Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/server` + - Run ```bash pnpm dev @@ -190,9 +190,9 @@ Deploy Flowise self-hosted in your existing infrastructure, we support various [ -## 💻 Cloud Hosted +## ☁️ Flowise Cloud -Coming soon +[Get Started with Flowise Cloud](https://flowiseai.com/) ## 🙋 Support diff --git a/i18n/CONTRIBUTING-ZH.md b/i18n/CONTRIBUTING-ZH.md index 00bc490296b..de1870ba691 100644 --- a/i18n/CONTRIBUTING-ZH.md +++ b/i18n/CONTRIBUTING-ZH.md @@ -165,5 +165,3 @@ npx flowise start --PORT=3000 --DEBUG=true ## 🏷️ Pull Request 流程 当您打开一个 Pull Request 时,FlowiseAI 团队的成员将自动收到通知/指派。您也可以在 [Discord](https://discord.gg/jbaHfsRVBW) 上联系我们。 - -## diff --git a/i18n/README-JA.md b/i18n/README-JA.md index 2e316917e03..dab0dd8439d 100644 --- a/i18n/README-JA.md +++ b/i18n/README-JA.md @@ -180,9 +180,9 @@ Flowise は、インスタンスを設定するためのさまざまな環境変 -## 💻 クラウドホスト +## ☁️ クラウドホスト -近日公開 +[Flowise Cloud の使い方を始める](https://flowiseai.com/) ## 🙋 サポート diff --git a/i18n/README-KR.md b/i18n/README-KR.md index 9d705417211..b34e226286f 100644 --- a/i18n/README-KR.md +++ b/i18n/README-KR.md @@ -180,9 +180,9 @@ Flowise는 인스턴스 구성을 위한 다양한 환경 변수를 지원합니 -## 💻 클라우드 호스팅 서비스 +## ☁️ 클라우드 호스팅 서비스 -곧 출시될 예정입니다. +[Flowise Cloud 시작하기](https://flowiseai.com/) ## 🙋 기술 지원 diff --git a/i18n/README-ZH.md b/i18n/README-ZH.md index 6137aaf35a2..dcbe172b5a1 100644 --- a/i18n/README-ZH.md +++ b/i18n/README-ZH.md @@ -180,9 +180,9 @@ Flowise 支持不同的环境变量来配置您的实例。您可以在 `package -## 💻 云托管 +## ☁️ 云托管 -即将推出 +[开始使用云托管](https://flowiseai.com/) ## 🙋 支持 diff --git a/packages/api-documentation/README-ZH.md b/packages/api-documentation/README-ZH.md new file mode 100644 index 00000000000..c8447f81ea2 --- /dev/null +++ b/packages/api-documentation/README-ZH.md @@ -0,0 +1,33 @@ + + +# Flowise API 文档 + +[English](./README.md) | 中文 + +这是 Flowise 公共 API 的列表,允许用户以编程方式执行与 GUI 中相同的许多任务。 + +独立运行: + +1. 启动 Flowise 服务器: + ```sh + cd Flowise + pnpm start + ``` +2. 启动 API 文档服务器: + ```sh + cd packages/api-documentation + pnpm start + ``` + +开发模式下运行: + +```sh +cd Flowise +pnpm dev +``` + +文档将在此地址提供:http://localhost:6655/api-docs + +## 许可证 + +此存储库中的源代码根据 Apache 2.0 许可证 提供 diff --git a/packages/api-documentation/README.md b/packages/api-documentation/README.md new file mode 100644 index 00000000000..1788561560a --- /dev/null +++ b/packages/api-documentation/README.md @@ -0,0 +1,33 @@ + + +# Flowise API Docs + +English | [中文](./README-ZH.md) + +A list of Flowise public APIs, allowing users to programmatically execute many of the same tasks as the same in the GUI. + +To run this standalone: + +1. Spin up Flowise server: + ```sh + cd Flowise + pnpm start + ``` +2. Start API Docs server: + ```sh + cd packages/api-documentation + pnpm start + ``` + +To run in dev mode: + +```sh +cd Flowise +pnpm dev +``` + +Docs will be served on: `http://localhost:6655/api-docs` + +## 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). diff --git a/packages/api-documentation/src/yml/swagger.yml b/packages/api-documentation/src/yml/swagger.yml index 379b15daf88..9e347ad5c0b 100644 --- a/packages/api-documentation/src/yml/swagger.yml +++ b/packages/api-documentation/src/yml/swagger.yml @@ -280,17 +280,17 @@ paths: schema: $ref: '#/components/schemas/Assistant' required: true - responses: - '200': - description: Assistant created successfully - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - '400': - description: Invalid input provided - '422': - description: Validation exception + responses: + '200': + description: Assistant created successfully + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + '400': + description: Invalid input provided + '422': + description: Validation exception get: tags: - assistants diff --git a/packages/server/README-ZH.md b/packages/server/README-ZH.md index 120522c4b64..a8e381b8038 100644 --- a/packages/server/README-ZH.md +++ b/packages/server/README-ZH.md @@ -47,25 +47,44 @@ npx flowise start --PORT=3000 --DEBUG=true ## 🌐 自托管 -### [Railway](https://docs.flowiseai.com/deployment/railway) +在您现有的基础设施中部署自托管的 Flowise,我们支持各种[部署](https://docs.flowiseai.com/configuration/deployment) -[![在Railway上部署](https://railway.app/button.svg)](https://railway.app/template/YK7J0v) +- [AWS](https://docs.flowiseai.com/deployment/aws) +- [Azure](https://docs.flowiseai.com/deployment/azure) +- [Digital Ocean](https://docs.flowiseai.com/deployment/digital-ocean) +- [GCP](https://docs.flowiseai.com/deployment/gcp) +-
+ 其他 -### [Render](https://docs.flowiseai.com/deployment/render) + - [Railway](https://docs.flowiseai.com/deployment/railway) -[![部署到Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render) + [![在 Railway 上部署](https://railway.app/button.svg)](https://railway.app/template/pn4G8S?referralCode=WVNPD9) -### [AWS](https://docs.flowiseai.com/deployment/aws) + - [Render](https://docs.flowiseai.com/deployment/render) -### [Azure](https://docs.flowiseai.com/deployment/azure) + [![部署到 Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render) -### [DigitalOcean](https://docs.flowiseai.com/deployment/digital-ocean) + - [HuggingFace Spaces](https://docs.flowiseai.com/deployment/hugging-face) -### [GCP](https://docs.flowiseai.com/deployment/gcp) + HuggingFace Spaces -## 💻 云托管 + - [Elestio](https://elest.io/open-source/flowiseai) -即将推出 + [![Deploy](https://pub-da36157c854648669813f3f76c526c2b.r2.dev/deploy-on-elestio-black.png)](https://elest.io/open-source/flowiseai) + + - [Sealos](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise) + + [![部署到 Sealos](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise) + + - [RepoCloud](https://repocloud.io/details/?app_id=29) + + [![部署到 RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=29) + +
+ +## ☁️ 云托管 + +[开始使用云托管](https://flowiseai.com/) ## 🙋 支持 diff --git a/packages/server/README.md b/packages/server/README.md index 0b93b6ac2cf..5f02c13d1f5 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -60,25 +60,42 @@ pnpm run e2e ## 🌐 Self Host -### [Railway](https://docs.flowiseai.com/deployment/railway) +- [AWS](https://docs.flowiseai.com/deployment/aws) +- [Azure](https://docs.flowiseai.com/deployment/azure) +- [Digital Ocean](https://docs.flowiseai.com/deployment/digital-ocean) +- [GCP](https://docs.flowiseai.com/deployment/gcp) +-
+ Others -[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/YK7J0v) + - [Railway](https://docs.flowiseai.com/deployment/railway) -### [Render](https://docs.flowiseai.com/deployment/render) + [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/pn4G8S?referralCode=WVNPD9) -[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render) + - [Render](https://docs.flowiseai.com/deployment/render) -### [AWS](https://docs.flowiseai.com/deployment/aws) + [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render) -### [Azure](https://docs.flowiseai.com/deployment/azure) + - [HuggingFace Spaces](https://docs.flowiseai.com/deployment/hugging-face) -### [DigitalOcean](https://docs.flowiseai.com/deployment/digital-ocean) + HuggingFace Spaces -### [GCP](https://docs.flowiseai.com/deployment/gcp) + - [Elestio](https://elest.io/open-source/flowiseai) -## 💻 Cloud Hosted + [![Deploy on Elestio](https://elest.io/images/logos/deploy-to-elestio-btn.png)](https://elest.io/open-source/flowiseai) -Coming Soon + - [Sealos](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise) + + [![](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise) + + - [RepoCloud](https://repocloud.io/details/?app_id=29) + + [![Deploy on RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=29) + +
+ +## ☁️ Flowise Cloud + +[Get Started with Flowise Cloud](https://flowiseai.com/) ## 🙋 Support