Building Modtree

Quick start#

1. Install build prerequisites on your system
2. git clone https://github.com/modtree/modtree.git
3. cd modtree && yarn setup

Run commands#

After a successful build, you can do some things:

1. Serve a local version of modtree

yarn dev

2. Serve a local version of the documentation site

yarn dev:docs

3. Run some Yarn Scripts
4. Run Tests

Build prerequisites#

1. Node v16
2. Yarn v1

Runtime requirements#

1. PostgreSQL

Uninstall#

Modtree doesn't install anything outside of the project root directory. To clear out all Modtree data, simply delete the project directory.