flowkit

Learn more »

Introduction · Getting Started · Contributing

Most automation platforms start out feeling magical — until you hit the walls. Drag-and-drop interfaces become a mess to maintain. Scaling grinds to a halt. And the real power is locked away behind enterprise licenses and escalating paywalls.

flowkit takes a different path. Workflows are defined in clean YAML, versioned and deployed like code, and executed on your own infrastructure without limits. Expressions let you drop in JavaScript wherever you need flexibility, while the engine stays lightweight, fast, and infinitely scalable.

Automation should grow with you, not against you. flowkit makes it possible.

---

Getting Started

This is the fastest way to run flowkit with your own workflows baked into the image.

1. Fork the repository

• Click Fork on GitHub to create your copy.

2. Add your workflows

• Create YAML files in ./data/workflows/ (in your fork).
• Example: ./data/workflows/my-workflow.yaml

---
connections:
  Webhook:
    main:
      - - node: Echo 1
          type: main
nodes:
  - name: Webhook
    type: webhook
    parameters:
      operation: default
  - name: Echo 1
    type: echo
    parameters:
      operation: default
      message: ="Hello from flowkit"

3. Commit to main

• Commit and push. The repo’s CI will build a Docker image that includes everything under ./data/workflows/.

4. Deploy the image

• Pull the image produced by your fork’s build (from your registry shown in the CI logs) and run it:

docker run -d \
  -p 3000:3000 \
  YOUR_REGISTRY/YOUR_REPO:latest

Tip: No volume mounts needed—the workflows are already baked into the image.

5. Execute a workflow

• The webhook path is the filename without the .yaml extension.

curl -X POST http://localhost:8080/api/v1/webhooks/my-workflow

If your container is reachable remotely, replace localhost with your host or load balancer address.

---

Contributing

We welcome contributions!

• Submit PRs for new nodes or bug fixes
• Open issues for discussion
• Share your workflows with the community

---

License

flowkit is open-source and licensed under the MIT License.