Skip to content

Update contributing docs now that sample runner is gone #751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 21, 2020
Merged

Update contributing docs now that sample runner is gone #751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d8bbb8
docs: update CONTRIBUTING now that runner is gone
jarmani Nov 21, 2020
a258a48
chore: remove samples command
jarmani Nov 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@ $ yarn dev

To test the sample applications provided in the repository, you need to `yarn 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).

Next, open up a new terminal window and run `yarn 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.
Next, open up a new terminal window and change directory to samples `cd samples`.

If you want to test the sample apps with HMR activated, please run `yarn samples -- --hmr` instead. Actually, we can pass any arguments to the `tns debug platform` command placing them after the `--` separator.
If you want to test the sample apps, please run `ns run <platform> --no-hmr` (disabling hmr isn't necessary, but preferred most of the time).

To test a different/new sample edit `app/entry.js` and update the `require('./<sample>')` statement to require any of the samples in the app folder.

# Project Structure

Expand Down
1 change: 0 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"scripts": {
"test": "jest",
"tdd": "jest --watch",
"samples": "node build/sample-runner.js",
"dev": "npm run dev:core -- -w & npm run dev:compiler -- -w",
"dev:core": "rollup -c build/config.js --o dist/index.js --environment TARGET:nativescript-vue",
"dev:compiler": "rollup -c build/config.js --environment TARGET:nativescript-vue-template-compiler",
Expand Down