Skip to content

Commit a7193c1

Browse files
author
PROGRESS\radeva
committed
docs: update dev workflow + add demo.ng commands
1 parent f6f9d58 commit a7193c1

File tree

2 files changed

+13
-29
lines changed

2 files changed

+13
-29
lines changed

DevelopmentWorkflow.md

Lines changed: 11 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,14 @@
44

55
- [Prerequisites](#prerequisites)
66
- [Develop locally](#develop-locally)
7-
- [Run locally](#run-locally)
8-
- [Install dependencies](#install-dependencies)
9-
- [Transpile TypeScript](#transpile-typescript)
10-
- [Run any of the demo apps](#run-any-of-the-demo-apps)
117
- [Run UI Tests](#run-ui-tests)
128

139
<!-- /TOC -->
1410

1511

1612
## Prerequisites
1713

18-
* Install your native toolchain and NativeScript as [described in the docs](https://docs.nativescript.org/plugins/plugins)
14+
* Install your native toolchain and NativeScript as [described in the docs](https://docs.nativescript.org/start/quick-setup)
1915

2016
* Review [NativeScript plugins documentation](https://docs.nativescript.org/plugins/plugins) for more details on plugins development
2117

@@ -24,43 +20,29 @@
2420

2521
For local development we recommend using the npm commands provided in the plugin's package.json
2622

27-
Basically executing the commands below will be enough for you to start making changes to the plugin and see them live synced in the demo:
23+
Basically executing a bunch of commands will be enough for you to start making changes to the plugin and see them live synced in the demo. It's up to you to decide which demo to use for development - TypeScript or TypeScript + Angular.
2824

25+
26+
To run and develop using TypeScript demo:
2927
```bash
3028
$ cd nativescript-imagepicker/src
3129
$ npm run demo.ios
3230
$ npm run demo.android
3331
```
3432

33+
To run and develop using TypeScript + Angular demo:
34+
```bash
35+
$ cd nativescript-imagepicker/src
36+
$ npm run demo.ng.ios
37+
$ npm run demo.ng.android
38+
```
39+
3540
After all the changes are done make sure to
3641
- test them in all the demo apps
3742
- run the UI tests.
3843

3944
For details on plugins development workflow, read [NativeScript plugins documentation](https://docs.nativescript.org/plugins/building-plugins#step-2-set-up-a-development-workflow) covering that topic.
4045

41-
## Run locally
42-
43-
### Install dependencies
44-
45-
```
46-
$ cd nativescript-imagepicker/src
47-
$ npm install
48-
```
49-
50-
### Transpile TypeScript
51-
```
52-
$ cd nativescript-imagepicker/src
53-
$ npm run tsc
54-
```
55-
56-
### Run any of the demo apps
57-
58-
The plugin has multiple demo apps added. To run any of them use the following commands:
59-
```
60-
$ cd nativescript-imagepicker/<demo-folder>
61-
$ tns run ios
62-
$ tns run android
63-
```
6446

6547
## Run UI Tests
6648

src/package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
"plugin.tscwatch": "npm run tsc -- -w",
2929
"demo.ios": "npm i && npm run tsc && cd ../demo && tns run ios --syncAllFiles",
3030
"demo.android": "npm i && npm run tsc && cd ../demo && tns run android --syncAllFiles",
31+
"demo.ng.ios": "npm i && npm run tsc && cd ../demo-angular && tns run ios --syncAllFiles",
32+
"demo.ng.android": "npm i && npm run tsc && cd ../demo-angular && tns run android --syncAllFiles",
3133
"clean": "rm -rf node_modules && cd ../demo && rm -rf hooks node_modules platforms && cd ../src && npm run plugin.link"
3234
},
3335
"keywords": [

0 commit comments

Comments
 (0)