Skip to content

Commit 1bb99f0

Browse files
committed
Update README with installation and development instructions.
1 parent d9132bb commit 1bb99f0

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
11
Integrating NativeScript with Angular 2.
2+
3+
# Running locally
4+
5+
6+
## Get submodule code
7+
8+
The project bundles the NativeScript modules and Angular as source code dependencies set up as git submodules. You need to get them by running:
9+
10+
$ git submodule update --init
11+
12+
## Install dependencies
13+
14+
You will need the [Android SDK](https://developer.android.com/sdk/) to build this project. Install it manually.
15+
16+
Then install the NativeScript tools according to: [this article](http://docs.nativescript.org/setup/quick-setup).
17+
18+
Then install the needed NPM packages:
19+
20+
$ npm install
21+
22+
## Compile and prepare NativeScript and Angular
23+
24+
$ (cd deps/angular/modules/angular2 && tsd reinstall)
25+
$ grunt prepare
26+
27+
## Initialize the test NativeScript app (ng-sample)
28+
29+
$ grunt shell:ngSampleInit
30+
31+
## Compile the app and update its `./src` dir:
32+
33+
$ grunt ng-sample
34+
35+
# Developer workflow:
36+
37+
1. Make some changes to the app or `src/nativescript-angular`
38+
2. Navigate to the ng-sample subdir: `cd ng-sample`
39+
2. Compile app: `grunt app`
40+
3. Run in emulator `tns emulate android --avd <YOUR-AVD>`
41+
42+
Protip: combine #2 and #3 above in a single command run from the project root directory (works only on Unixy shells):
43+
44+
(cd ng-sample && grunt app && tns emulate android --avd nexus4-x64)
45+
46+
On Windows, you can wrap those commands in a BAT file.

0 commit comments

Comments
 (0)