diff --git a/.npmrc b/.npmrc new file mode 100644 index 000000000..b6f27f135 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +engine-strict=true diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index c553a58f5..8707e0d55 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -2,9 +2,9 @@ There are many ways to [contribute](/CONTRIBUTING.md) to this project. -* [Discuss open issues](/issues) to help define the future of the project. -* [Submit bugs](/issues) and help us verify fixes as they are checked in. -* Review and discuss the [source code changes](pulls). +* [Discuss open issues](https://github.com/wpengine/faustjs/issues) to help define the future of the project. +* [Submit bugs](https://github.com/wpengine/faustjs/issues) and help us verify fixes as they are checked in. +* Review and discuss the [source code changes](https://github.com/wpengine/faustjs/pulls). * [Contribute bug fixes](/CONTRIBUTING.md) ## Project Structure @@ -15,13 +15,14 @@ There are many ways to [contribute](/CONTRIBUTING.md) to this project. ### NPM Packages -When working on the npm packages in this repository, use our Lerna setup from the project root: +NPM packages are managed from the project root using [Workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces). To get started, run: -1. Ensure that `.env.local` exists and is correctly configured in `examples/getting-started` and `examples/preview`. -2. `npm run bootstrap` -3. `npm run dev` +1. `npm install` +2. `npm run dev` -When switching git branch, run `npm run clean` from the root and then re-run `npm run bootstrap`. +The local copy of each package is automatically symlinked in `node_modules` when running `npm install` from the project root. Likewise, each package is automatically built when running `npm run dev`. + +When switching git branch, run `npm run clean` from the root and then re-run `npm run dev`. ### Plugins diff --git a/README.md b/README.md index 9bbfe37c8..05b2d05cf 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ Additionally, if you have questions or ideas, please share them on [GitHub Discu There are many ways to [contribute](/CONTRIBUTING.md) to this project. -- [Discuss open issues](/issues) to help define the future of the project. -- [Submit bugs](/issues) and help us verify fixes as they are checked in. -- Review and discuss the [source code changes](pulls). +- [Discuss open issues](https://github.com/wpengine/faustjs/issues) to help define the future of the project. +- [Submit bugs](https://github.com/wpengine/faustjs/issues) and help us verify fixes as they are checked in. +- Review and discuss the [source code changes](https://github.com/wpengine/faustjs/pulls). - [Contribute bug fixes](/CONTRIBUTING.md) diff --git a/package.json b/package.json index f124db6d8..a0a16cb0f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,10 @@ { "name": "root", "private": true, + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + }, "workspaces": { "packages": [ "packages/core",