View on GitHub

flownote

FlowNote lets developers create, organize, and reason about event-oriented applications with a simple flow-based language.

Installation

FlowNote can be added to any NodeJS project with NPM or Yarn:

npm install esm flownote@next --production --save

yarn add esm flownote@next --production

After that, copy the default .env file to your directory with:

cp node_modules/flownote/.env .env

If you already have a .env file, do the following:

cat node_modules/flownote/.env >> .env

Then open the .env and change the variables according to the documentation within.

Docker

If you’d like to install FlowNote as a standalone server for Docker, do the following:

./node_modules/.bin/flownote flownote-docker

Quick Start

mkdir ~/someFlowNoteProject
cd ~/someFlowNoteProject
npm init
npm install esm flownote@next --production --save
cp node_modules/flownote/.env .env

# Change this file to make the actions you want
cp node_modules/flownote/compiler/testActions.js actions.js

# Change this file for the FlowNote code you want
cp node_modules/flownote/compiler/test.flow app.flow

From here, replace the first line in the actions.js file with:

const esm = require('esm')
require = esm(module)
const { Action } = require('flownote')

Then run:

./node_modules/.bin/flownote start-http --standalone --flow=app.flow

Use Cases

You’re ready to begin! Check out the common use cases of FlowNote to learn how to get started.

Documentation