⚠️ LetsFlow is continuing as library. Use @letsflow/core directly in your project.

LetsFlow is a workflow engine for running processes, described in YAML or JSON.

schema: "https://schemas.letsflow.io/v1.0/scenario"
title: My first scenario

actors:
  user:
    title: The user

actions:
  complete:
    title: Complete the process

states:
  initial:
    on: complete
    goto: (success)

The scenario models a process as a fine state machine. The actors are persons, organizations or systems that are allowed to participate on the process by performing actions. Which actions can be performed depends on the current state of the process. After an action has been, the process will transition to a different state.

Read the documentation

Installation

$ npm install

Running the app

# development
$ npm run start

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov