Skip to content

Commit 3bd090e

Browse files
committed
Update bootstrap script to include building packages.
1 parent 8e95cc2 commit 3bd090e

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,12 @@ To start working on React Async, clone the repo and bootstrap the project:
1818
```sh
1919
git clone https://github.com/async-library/react-async.git
2020
cd react-async
21+
<<<<<<< HEAD
2122
yarn && yarn bootstrap
2223
yarn build && yarn test
24+
=======
25+
yarn && yarn bootstrap && yarn test
26+
>>>>>>> bef2266... Update bootstrap script to include building packages.
2327
```
2428

2529
### Working with Storybook
@@ -76,4 +80,16 @@ This runs all tests using various versions of `react` and `react-dom`, to check
7680

7781
### Working with the examples
7882

79-
In the `examples` folder, you will find sample React applications that use React Async in various ways with various other libraries. Please add a new example when introducing a major new feature.
83+
In the `examples` folder, you will find sample React applications that use React Async in various ways with various other libraries. Please add a new example when introducing a major new feature. Make sure to add it to `now.json` so it is automatically deployed when merged to `master`.
84+
85+
To run sample examples on your local environments
86+
87+
```sh
88+
yarn build:examples
89+
yarn test:examples
90+
yarn start:examples
91+
```
92+
93+
### Resolving issues
94+
95+
Sometimes your dependencies might end up in a weird state, causing random issues, especially when working with the examples. In this case it often helps to run `yarn clean -y && yarn bootstrap`. This will delete `node_modules` from all packages/examples and do a clean install.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"packages/*"
1111
],
1212
"scripts": {
13-
"bootstrap": "yarn workspaces run install",
13+
"bootstrap": "yarn build:packages && yarn workspaces run install",
1414
"clean": "lerna clean",
1515
"start": "run-p start:*",
1616
"start:examples": "now dev",

0 commit comments

Comments
 (0)