8000 Update guide for running the sample apps. · rdlauer/nativescript-vue@6cce337 · GitHub
[go: up one dir, main page]

Skip to content

Commit 6cce337

Browse files
authored
Update guide for running the sample apps.
1 parent 4e78810 commit 6cce337

File tree

1 file changed

+4
-27
lines changed

1 file changed

+4
-27
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -30,38 +30,15 @@ After cloning the repo, run:
3030
# Commonly used NPM scripts
3131

3232
```bash
33-
# watch and auto re-build dist/index.js
33+
# watch and auto re-build samples/app/nativescript-vue.js
3434
$ npm run dev
3535
```
3636

37-
# Testing with the sample application
37+
# Testing with the sample application(s)
3838

39-
First, **[link](https://docs.npmjs.com/cli/link) the development version** to make it available globally.
39+
To test the sample applications provided in the repository, you need to `npm run dev` in the root directory. This will watch for changes, and rebuild nativescript-vue, which in dev mode will be generated into the samples/app directory (this has been done to reduce the required steps of linking local packages, which had many issues with the recent releases of npm).
4040

41-
```
42-
cd nativescript-vue
43-
npm link
44-
```
45-
46-
This will create a symbolic link in your global `node_modules` folder, pointing to this location.
47-
48-
Then, **run the sample app** after linking it to the development code.
49-
50-
```
51-
cd samples
52-
npm link nativescript-vue
53-
```
54-
55-
If all went well, `samples/node_modules/nativescript-vue` should be a link to your global `node_modules/nativescript` folder, which is is also a link to the actual package.
56-
57-
Finally, run the application :
58-
59-
```
60-
npm install
61-
tns run android --syncAllFiles
62-
```
63-
64-
The `--syncAllFiles` option reloads the application every time the `nativescript-vue` module changes.
41+
Next, open up a new terminal window and run `npm run samples`. This will bring up a list of all the available sample applications which you can choose from with your arrow keys. Pressing enter/return will select that sample, and prompt you to choose the platform you'd like to run the sample on. After selecting the platform the application should start on your emulator, and the output will be in your terminal.
6542

6643
# Project Structure
6744

0 commit comments

Comments
 (0)
0