# Installation Guide of node.console.web

## Table of Contents

  1. [System requirements](#1-system-requirements)
  2. [Preparation](#2-preparation)
  3. [Launch](#3-launch)
  4. [References](#4-references)

## 1. System requirements

+ OS

  + Linux, Windows, MacOS

+ nodejs

  + For support on installing nodejs, see https://git.faronear.org/tic/doc/src/master/InstallationGuide/nodejs.md

+ git

  + For support on installing git, see https://git.faronear.org/tic/doc/src/master/InstallationGuide/git.md

+ node.server
  
  + See https://git.faronear.org/tic/node.server/src/master/InstallationGuide.md

## 2. Preparation

2.1 Download source code

```
git clone https://git.faronear.org/tic/node.console.web
cd node.console.web
git checkout master
```

2.2 Install dependencies

```
npm install
```

## 3. Launch

1. `run lint` to format files
   
   ```
   npm run lint
   ```
   
2. `run dev` to test source code and 'hot-start' in a local web server
  
    ```
    npm run dev
    ```

3. `run dist` to pack source code into html/css/js for distribution

    ```
    npm run dist
    ```

4. `run deploy` to upload distribution to remote host

    ```
    npm run deploy -- -p '远程登录密码' -k "用户私钥文件" -u '远程登录用户' -r '远程路径' -H '远程主机' -P '远程端口'
    ```
    或者不借助 npm, 直接调用 deploy.js:
    ```
    node deploy.js -p 远程登录密码' -k "用户私钥文件" -u '远程登录用户' -r '远程路径' -H '远程主机' -P '远程端口'
    ```

5. `run daemon` to launch web server on remote host

    登录到远程主机，进入 node.console.web 目录，然后
    ```
    npm run daemon
    ```
    启动 web 服务。

## 4. References

+ 返回上级文档：https://git.faronear.org/tic/node.console.web
+ 返回根文档：https://git.faronear.org/tic/doc/