Skip to content

Commit d21d7df

Browse files
Avi98ghengeveld
authored andcommitted
updated contribute.md to run examples (#110)
* updated contribute to run examples * updated examples md
1 parent c3fe2cc commit d21d7df

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ 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-
yarn && yarn bootstrap
21+
yarn && yarn build:packages
22+
yarn bootstrap
2223
yarn build && yarn test
2324
```
2425

@@ -80,6 +81,12 @@ This runs all tests using various versions of `react` and `react-dom`, to check
8081

8182
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`.
8283

84+
To run sample examples on your local environments
85+
86+
```sh
87+
yarn start:examples
88+
```
89+
8390
### Resolving issues
8491

8592
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.

0 commit comments

Comments
 (0)