Contribution Guide

Setup

Stackflow only works in Node.js version 16.x.

Install the dependencies by entering the following command in the project root

$ yarn

Stackflow uses Yarn 3 and Yarn workspace

Build all packages

$ yarn build

...or you can build each packages by yarn workspace command

# Build @stackflow/core
$ yarn workspace @stackflow/core build

# Build @stackflow/react
$ yarn workspace @stackflow/react build

You can start your project in the /demo folder with the following command

$ yarn workspace @stackflow/demo dev:app

View the changes in the demo project for testing while editing other packages as follows:

$ yarn dev