Flowlitics Documentation

Your comprehensive guide to installing, using, and developing with the Flowlitics ecosystem.

Comprehensive Guides & Resources

A central place for all documentation related to installing, using, and developing with the Flowlitics ecosystem.

Getting Started

Begin your journey with Flowlitics by setting up the backend engine and the frontend visual editor.

Installation

  • Backend Engine: Clone the repository, install dependencies with npm install, configure your .env file, and run the server. Detailed steps are in the Backend README.
  • Frontend Visual Editor: Set up the Vue.js frontend, including cloning, installing dependencies, and running the development server. Refer to the Frontend README.

Visual Editor Guide

Learn how to effectively use the Flowlitics Visual Editor to design and manage your workflows.

  • Creating & Managing Flows: Steps to create, name, describe, tag, and manage your workflows from the dashboard.
  • Working with Nodes: Add different types of nodes (actions, decisions, etc.), and configure their properties, agents, and logic.
  • Connecting Nodes: Establish links between nodes to define the flow of execution and create complex logic paths.
  • Using the Mermaid View: Understand the auto-generated Mermaid diagram and its interactive features for a clear overview.

For more visual examples, please see the Visual Editor page.

Backend & API Reference

Understand the architecture, capabilities, and API endpoints of the Flowlitics backend.

API Reference

The backend exposes a comprehensive RESTful API for programmatic control. All endpoints are documented using the OpenAPI v3 standard.

Access API Documentation

For more architecture details, visit the Backend Engine page.

Contributing to Flowlitics

Flowlitics is an open-source project, and contributions are highly welcome! Whether it's code, documentation, bug reports, or feature suggestions, your help is valuable.