Skip to content

Update 3-installation.md #250

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

Open
funzeye wants to merge 1 commit into
base: v2
Choose a base branch
from
+44 −18
Open

Update 3-installation.md #250

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
62 changes: 44 additions & 18 deletions content/docs/en/getting-started/3-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,12 @@ contributors: [rigor789, TheOriginalJosh, eddyverbruggen, ikoevska]

To use NativeScript-Vue, you need to set up your system to compile your apps.

## Prerequisites
## Choose your System

- [Node.js](#nodejs)
- [NativeScript CLI](#nativescript-cli)
- [Windows](#windows) (for developing Android applications on Windows)
- [macOS](#macos) (for developing iOS and Android applications on macOS)
- [Linux](#linux) (for developing Android applications on Linux)

### Node.js

Download and install the latest _LTS_ version of Node.js from [https://nodejs.org/](https://nodejs.org/). Restart your terminal and verify the installation was successful by running `node --version`.

### NativeScript CLI

To install the NativeScript CLI, open your terminal and run:

```shell
$ npm install -g nativescript
```

Verify the installation was successful by running `tns` in your terminal. You should see a list of the available commands.

### Windows

Check the system requirements and follow the setup instructions for the Android SDK on Windows:
Expand All @@ -43,4 +27,46 @@ Check the system requirements and follow the setup instructions for Xcode and th

Check the system requirements and follow the setup instructions for the Android SDK on Linux:

[Advanced setup: Linux](https://docs.nativescript.org/start/ns-setup-linux)
[Advanced setup: Linux](https://docs.nativescript.org/start/ns-setup-linux)

## What you should now have installed

- Node.js
- Android SDK (and Xcode if macOS)
- Android Device Emulator
- NativeScript CLI

## Next: Install Vue CLI and Create NativeScript-Vue Project

```shell
$ npm install -g @vue/cli @vue/cli-init
$ vue init nativescript-vue/vue-cli-template <project-name>
$ cd <project-name>
$
$ npm install
$ # or
$ yarn install
$
$ tns run android --bundle
$ # or
$ tns run ios --bundle
$
$ # You may also try the new HMR mode by replacing --bundle
$ # with --hmr, but note that this is a beta feature.
```

This set of commands performs the following operations on your system:

1. Installs the latest Vue CLI and support for Vue CLI 2.x templates through the `@vue/cli-init` add-on.
2. Creates a project using the [vue-cli-template](https://github.com/nativescript-vue/vue-cli-template).
3. Switches to the directory containing the newly created project.
4. Installs any npm dependencies locally.
5. Builds and runs the project on any connected devices or installed emulators for the selected platform. The `--bundle` option triggers a webpack build, which compiles `.vue` files and watches for changes.

**Supported features**

- `.vue` single file components
- Vuex&mdash;state management (opt-in)
- NativeScript themes
- Application presets