Skip to content

cloniumagent/klonium-flow

 
 

Repository files navigation

This is a fork of https://github.com/FlowiseAI/Flowise

Build LLM Apps Easily

Drag & drop UI to build your customized LLM flow

⚡Quick Start

Download and Install NodeJS >= 18.15.0

  1. Install klonium-flow

    npm install -g klonium-flow
  2. Start klonium-flow

    npx klonium-flow start

    With username & password

    npx klonium-flow start --FLOWISE_USERNAME=user --FLOWISE_PASSWORD=1234
  3. Open http://localhost:3000

🐳 Docker

Docker Compose

  1. Go to docker folder at the root of the project
  2. Copy .env.example file, paste it into the same location, and rename to .env
  3. docker-compose up -d
  4. Open http://localhost:3000
  5. You can bring the containers down by docker-compose stop

Docker Image

  1. Build the image locally:

    docker build --no-cache -t klonium-flow .
  2. Run image:

    docker run -d --name klonium-flow -p 3000:3000 klonium-flow
  3. Stop image:

    docker stop klonium-flow

Developers

3 different modules in a single mono repository.

  • server: Node backend to serve API logics
  • ui: React frontend
  • components: Langchain components

Prerequisite

Setup

  1. Clone the repository

    git clone https://github.com/cloniumagent/klonium-flow.git
  2. Go into repository folder

    cd klonium-flow
  3. Install all dependencies of all modules:

    yarn install
  4. Build all the code:

    yarn build
  5. Start the app:

    yarn start

    You can now access the app on http://localhost:3000

  6. For development build:

    • Create .env file and specify the PORT (refer to .env.example) in packages/ui

    • Create .env file and specify the PORT (refer to .env.example) in packages/server

    • Run

      yarn dev

    Any code changes will reload the app automatically on http://localhost:8080

🔒 Authentication

To enable app level authentication, add FLOWISE_USERNAME and FLOWISE_PASSWORD to the .env file in packages/server:

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

📖 Documentation

Look at the original project documentation: Flowise Docs

📄 License

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

About

UI to build your customized LLM flow using LangchainJS

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 57.8%
  • JavaScript 40.5%
  • CSS 0.8%
  • SCSS 0.5%
  • HTML 0.3%
  • Dockerfile 0.1%