Sultan
/
Flowise
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Flowise/packages/server
History
Henry Heng d9a2c334a0
Feature/Update API Docs README (#3078) 
* Add interactive swagger-ui auto-generated API docs from express

* Update README.md

* Update index.ts //@ts-ignore

* Fix eslint no-console error

* Add swagger paths

* Add all end  points

* Update swagger.yml

* update swagger yml file

* update swagger config

* update swagger response indentation

* update api-docs README

* update README

---------

Co-authored-by: Octavian FlowiseAI <154992625+ocflowiseai@users.noreply.github.com>
 		2024-08-25 14:53:59 +01:00
..
bin Fix for #911, CRLF line endings, new fix. 2023-10-16 16:30:25 -04:00
cypress feature: modularized express routes for reusability, testability, composability and performance (#2030) 2024-04-02 16:44:04 +01:00
marketplaces Feature/add ability to upload file from chat (#3059) 2024-08-25 13:22:48 +01:00
src Feature/add ability to upload file from chat (#3059) 2024-08-25 13:22:48 +01:00
test/utils Feature: interactive swagger-ui auto-generated API docs from express (#1812) 2024-08-25 13:22:07 +01:00
.env.example Feature/Community Node (#2902) 2024-07-29 16:52:47 +01:00
README-ZH.md Feature/Update API Docs README (#3078) 2024-08-25 14:53:59 +01:00
README.md Feature/Update API Docs README (#3078) 2024-08-25 14:53:59 +01:00
babel.config.js Initial push 2023-04-06 22:17:34 +01:00
cypress.config.ts feature: modularized express routes for reusability, testability, composability and performance (#2030) 2024-04-02 16:44:04 +01:00
nodemon.json Minor changes to running in dev mode. 2023-12-05 18:05:38 -05:00
package.json Release/2.0.5 (#3001) 2024-08-12 14:51:17 +01:00
tsconfig.json update server ts config to exclude test.ts 2024-05-29 18:22:41 +01:00

README.md

Flowise - Low-Code LLM apps builder

English | 中文

Flowise

Drag & drop UI to build your customized LLM flow

⚡Quick Start

  1. Install Flowise

    npm install -g flowise

  2. Start Flowise

    npx flowise start

  3. Open 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

You can also specify the env variables when using npx. For example:

npx flowise start --PORT=3000 --DEBUG=true

📖 Tests

We use Cypress for our e2e testing. If you want to run the test suite in dev mode please follow this guide:

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

🌐 Self Host

☁️ Flowise Cloud

Get Started with Flowise Cloud

🙋 Support

Feel free to ask any questions, raise problems, and request new features in discussion

🙌 Contributing

See contributing guide. Reach out to us at Discord if you have any questions or issues.

📄 License

Source code in this repository is made available under the Apache License Version 2.0.