Skip to content

Commit

Permalink
Update development docs (wpengine#446)
Browse files Browse the repository at this point in the history
* docs: update broken relative links

* chore: enforce project engine requirements

* docs: update npm package install and build instructions
  • Loading branch information
apmatthews authored Sep 10, 2021
1 parent 79291fe commit 16a20e9
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 11 deletions.
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
engine-strict=true
17 changes: 9 additions & 8 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{
"name": "root",
"private": true,
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"workspaces": {
"packages": [
"packages/core",
Expand Down

0 comments on commit 16a20e9

Please sign in to comment.