Rill Flow Documentation

Before developing with Flow Graph Frontend, ensure you are familiar with the following technologies:

• Core Runtime/Build: Node.js, Git, and Vite.
• Frontend Framework: Vue3 and TypeScript.
• UI & Graphing: Ant-Design-Vue (UI library) and Graph Editing Engine X6 (graphing engine).
• Micro-frontends: QianKun.
• Language: ES6+ syntax.

To develop or contribute to Flow Graph, you should be familiar with the following technologies:

• Runtime/Build Tools: Node.js, Git, and Vite
• Core Frameworks: Vue3 and TypeScript
• UI & Graphing: Ant-Design-Vue and X6 Graph Editing Engine
• Micro-frontends: QianKun
• Language: ES6+

To run Rill Flow locally, ensure you have Docker and Docker-Compose installed on an OSX or Linux environment. Follow these steps to deploy the services:

1. Clone the repository:

   git clone https://github.com/weibocom/rill-flow.git

2. Navigate to the docker directory and start the services:

   cd rill-flow/docker
   docker-compose up -d

   Note: If using Docker Compose V2, use docker compose instead of docker-compose.

3. Verify the installation by checking the container status:

   docker-compose ps

Expected running services include rill-flow-mysql, rillflow_cache_1, rillflow_jaeger_1, rillflow_rill-flow_1, rillflow_sample-executor_1, and rillflow_ui_1.

To run Rill Flow locally, you need an OSX/Linux environment with Docker and Docker-Compose installed. Follow these steps to deploy the service using the provided Docker configuration:

1. Clone the repository:

   git clone https://github.com/weibocom/rill-flow.git

2. Start the services: Navigate to the docker directory within the cloned repository and run the compose command:

   cd rill-flow/docker
   docker-compose up -d

   Note: If you are using Docker Compose V2, use docker compose instead of docker-compose.

3. Verify the installation: Run docker-compose ps to ensure all services are in the Up state. Expected services include rill-flow-mysql, rillflow_cache_1, rillflow_jaeger_1, rillflow_rill-flow_1, rillflow_sample-executor_1, and rillflow_ui_1.

Before developing or running Rill Flow UI, ensure you have the following tools and technologies installed or are familiar with them:

• Runtime/Tools: node, git, and pnpm
• Build Tool: Vite
• Frontend Framework: Vue3
• Language: TypeScript and ES6+
• Routing: Vue-Router-Next
• UI Library: Ant-Design-Vue
• Micro-frontend Framework: QianKun

To create a Docker image for the Java executor, use the provided Rill Flow packaging script located at executor-web/docker/build_image.sh.

sh build_image.sh

Once dependencies are installed, use the following pnpm commands to run the development server or build the production assets.

Run development server

pnpm serve

Build for production

pnpm build:prod

Flow Graph Frontend is a Vue3-based application utilizing the X6 Graph Editing Engine. To set up your development environment, follow these steps:

1. Install nvm (Node Version Manager):

   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash

2. Install Node.js v18.19.0 and set it as the default:

   nvm install v18.19.0
   nvm alias default v18.19.0

3. Install pnpm globally:

   npm install -g pnpm --registry=https://registry.npmmirror.com

4. Install dependencies in the flow-graph directory:

   cd flow-graph
   pnpm install

5. Run the development server:

   pnpm serve

6. Build for production:

   pnpm build:prod

After defining a flow, you can trigger its execution and monitor results:

1. Test Execution: In the Flow Definition page, click the Test button, provide the required parameters, and click Submit.
2. View Results: Upon submission, you will be redirected to the execution details page.
3. Execution Records: To see a history of runs and their statuses, click the Execution Records button.

Navigate to the rill-flow-ui directory to install project dependencies and start the development server or build the production bundle.

Install dependencies

cd rill-flow-ui
pnpm install

Run development server

pnpm serve

Build for production

pnpm build:prod