decoupled-kit-js

Pantheon Systems Decoupled Kits

Prerequisites

To setup the monorepo for development the following should be installed locally:

1. Nodejs version 16 LTS. We reccomend using nvm
2. npm version 8.x.x
3. The latest version of pnpm (6.32.3 at time of writing) - You can set pnpm as your package manager using corepack with the following command:

corepack prepare pnpm@6.32.3 --activate

Getting started

1. Fork this repo
2. clone your fork to your local machine
3. run pnpm install to install dependencies for all packages and starters

From here the workflow depends on what you're doing.

• to test all projects in the monorepo that have a test script, run pnpm test
• to build all packages in the monorepo, run pnpm build:pkgs
• to build all starters in the monorepo, run pnpm build:starters
• to build all projects in the monorepo, run pnpm build:all

To run commands in targeted projects, folders, or workspaces, pnpm offers a filter flag.

For example, to start the Gatsby starter from the root of the monorepo (filter by namespace):

pnpm --filter '*/gatsby*' run develop

To run lint in the starters (filter by directory):

pnpm --filter ./starters lint

To run documentation:

pnpm --filter ./web start