Skip to content

Commit f6f9d58

Browse files
author
PROGRESS\radeva
committed
docs: update development workflow steps
1 parent 227f7b2 commit f6f9d58

File tree

1 file changed

+37
-24
lines changed

1 file changed

+37
-24
lines changed

DevelopmentWorkflow.md

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,64 @@
22

33
<!-- TOC depthFrom:2 -->
44

5-
- [Running locally](#running-locally)
6-
- [Prerequisites](#prerequisites)
5+
- [Prerequisites](#prerequisites)
6+
- [Develop locally](#develop-locally)
7+
- [Run locally](#run-locally)
78
- [Install dependencies](#install-dependencies)
8-
- [Run the demo app](#run-the-demo-app)
9-
- [Run the demo-angular app](#run-the-demo-angular-app)
9+
- [Transpile TypeScript](#transpile-typescript)
10+
- [Run any of the demo apps](#run-any-of-the-demo-apps)
1011
- [Run UI Tests](#run-ui-tests)
11-
- [Developer workflow](#developer-workflow)
1212

1313
<!-- /TOC -->
1414

15-
## Running locally
1615

17-
### Prerequisites
16+
## Prerequisites
1817

1918
* Install your native toolchain and NativeScript as [described in the docs](https://docs.nativescript.org/plugins/plugins)
2019

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

2322

23+
## Develop locally
24+
25+
For local development we recommend using the npm commands provided in the plugin's package.json
26+
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:
28+
29+
```bash
30+
$ cd nativescript-imagepicker/src
31+
$ npm run demo.ios
32+
$ npm run demo.android
33+
```
34+
35+
After all the changes are done make sure to
36+
- test them in all the demo apps
37+
- run the UI tests.
38+
39+
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.
40+
41+
## Run locally
42+
2443
### Install dependencies
2544

2645
```
2746
$ cd nativescript-imagepicker/src
2847
$ npm install
2948
```
3049

31-
### Run the demo app
32-
From the `src` folder
50+
### Transpile TypeScript
3351
```
34-
$ npm run demo.ios
35-
$ npm run demo.android
52+
$ cd nativescript-imagepicker/src
53+
$ npm run tsc
3654
```
3755

38-
### Run the demo-angular app
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:
3959
```
40-
$ cd nativescript-imagepicker/demo-angular
41-
$ tns run ios
60+
$ cd nativescript-imagepicker/<demo-folder>
61+
$ tns run ios
4262
$ tns run android
43-
4463
```
4564

4665
## Run UI Tests
@@ -54,9 +73,9 @@ $ tns run android
5473

5574
3. Build the app for Android or iOS
5675
```bash
57-
tns run android/ios
76+
tns build android
77+
tns build ios
5878
```
59-
6079
4. Install [appium](http://appium.io/) globally.
6180
``` bash
6281
npm install -g appium
@@ -69,10 +88,4 @@ $ tns run android
6988
npm run e2e -- --runType capabilityName
7089
```
7190

72-
## Developer workflow
73-
74-
1. Make changes to the plugin or the demo
75-
2. Run the UI tests or any of the demos as shown above.
76-
Having any of the demos running, the changes made to the plugin will be automatically applied in the demo.
77-
78-
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.
91+
[Read more about UI testing](https://docs.nativescript.org/plugins/ui-tests).

0 commit comments

Comments
 (0)