Skip to content

Commit 58e1ba3

Browse files
Jami LurockJami Lurock
Jami Lurock
authored and
Jami Lurock
committed
update contribution instructions
1 parent 762c6de commit 58e1ba3

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,25 +59,38 @@ Install dependencies for angular-playground:
5959
npm i
6060
```
6161
62+
Build angular-playground package and link it globally
63+
```
64+
npm run clean
65+
npm run build
66+
npm link
67+
```
68+
6269
Then install dependencies for the example-app:
6370
```
6471
cd ./examples/cli-example/
6572
npm i
73+
npm link angular-playground
6674
```
6775
### Running the example app
6876
From `./examples/cli-example`:
6977
```
70-
npm run playground:build && npm run playground
78+
npm run playground
7179
```
7280
7381
From this point you can work on the Playground and make changes to the source code. You will need to stop the Playground
7482
from running and build the app again (run `npm run restage` from the source code root after your changes). Then run `npm run playground`
7583
in the example app root folder again to see the changes you made to the source code in action.
7684
85+
Rebuild Playground
7786
```
7887
Ctrl-C (stop playground)
7988
cd ../../
80-
npm run restage
89+
npm run rebuild
90+
```
91+
92+
Run the example App
93+
```
8194
cd examples/cli-example/
8295
npm run playground
8396
```

examples/cli-example/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ from running and rebuild the angular-playground then run the example app again.
3232

3333
Rebuild Playground
3434
```
35+
Ctrl-C (stop playground)
3536
cd ../..
3637
npm run rebuild
3738
```

examples/cli-example/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
"playground:prod": "angular-playground --build",
1414
"playground:prod-service-worker": "angular-playground --build-with-service-worker",
1515
"playground:check-errors": "angular-playground --check-errors",
16-
"playground:build": "(cd ../../ && sh ./scripts/build.sh)",
1716
"verify-sandboxes": "angular-playground --config .angular-playground/angular-playground.json --check-errors --report-path ./result.xml --report-type xml",
1817
"check-snapshots": "angular-playground --config .angular-playground/angular-playground.json --check-visual-regressions --visual-regression-mock-date 1577865600000",
1918
"update-snapshots": "angular-playground --config .angular-playground/angular-playground.json --check-visual-regressions --update-snapshots --path-to-sandboxes app/feature1",

0 commit comments

Comments
 (0)