node-base-monorepo-starter's Introduction

Node Typescript Monorepo Starter

A simple and easy to use typescript monorepo configured for Node. This monorepo uses lerna and yarn workspaces to orchestrate the monorepo.

Adding new NPM dependencies

Command	Description
`yarn add <dependency> -W`	Adds the NPM dependency to the root package to be used across all packages.
`lerna add <dependency>`	Adds the NPM dependency to ALL packages.
`lerna add <dependency> --scope=<package>`	Adds the NPM dependency to a specific package
`lerna add <package> --scope=<package>`	Adds a local package as a dependency into another specific package. Should run `yarn bootstrap` first.

Command	Description
`lerna create <package>`	Creates a new package under `/packages`.

Command	Description
`lerna run start --scope=<package>`	Run the `start` command that is available in a specific package under `/packages`

These commands are added to package.json as a easy way to run certain combination of commands together.

Command	Description
`yarn setup`	Sets up the monorepo.
`yarn build`	Runs all `build` command that is available in the packages, typically to compile typescripts.
`yarn boostrap`	As the packages are supposed to be typesripts, this command runs `yarn tsc` first and then `lerna bootstrap` to bootstrap everything together nicely.
`yarn lint`	Runs all `lint` command that is available in the packages in parallel.
`yarn start`	Runs all `start` comamnd that is available in the packages in parallel.
`yarn clean`	Runs all `start` comamnd that is available in the packages.
`yarn clear`	Runs `yarn clean` and `lerna clean` to clean out the monorepo.
`yarn reset`	Cleans and clear the monorepo and then reinstall, build and bootstrap all packages.

Recommend Projects