move [Installation.md] contents to [README.md]
This commit is contained in:
82
README.md
82
README.md
@@ -9,6 +9,84 @@
|
||||
* 原型 [tic/node.console.design](https://git.faronear.org/tic/node.console.design)
|
||||
* **<font size=5>客户端 [tic/node.console.web](https://git.faronear.org/tic/node.console.web)</font>**
|
||||
|
||||
## 文档资料
|
||||
* 安装指南 [./doc/Installation.md](./doc/Installation.md)
|
||||
|
||||
## Installation Guide | 安装指南
|
||||
|
||||
### Table of Contents
|
||||
|
||||
1. [Requirements](#1-requirements)
|
||||
2. [Preparation](#2-preparation)
|
||||
3. [Launch](#3-launch)
|
||||
|
||||
### 1. Requirements
|
||||
|
||||
+ OS
|
||||
|
||||
+ Linux, Windows, MacOS
|
||||
|
||||
+ nodejs
|
||||
|
||||
+ For support on installing nodejs, see <https://git.faronear.org/lib/coding/src/master/JavaScript/nodejs.md>
|
||||
|
||||
+ git
|
||||
|
||||
+ For support on installing git, see <https://git.faronear.org/lib/coding/src/master/VCS/git.md>
|
||||
|
||||
+ node.server
|
||||
|
||||
+ See <https://git.faronear.org/tic/node.server/src/master/doc/Installation.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. `lint` to format files
|
||||
|
||||
```
|
||||
npm run lint
|
||||
```
|
||||
|
||||
2. `dev` to test source code and 'hot-start' in a local web server
|
||||
|
||||
```
|
||||
npm run dev
|
||||
```
|
||||
|
||||
3. `dist` to pack source code into html/css/js for distribution
|
||||
|
||||
```
|
||||
npm run dist
|
||||
```
|
||||
|
||||
4. `deploy` to upload distribution to a TIC node host
|
||||
|
||||
```
|
||||
npm run deploy -- -p '远程登录密码' -k "用户私钥文件" -u '远程登录用户' -r '远程路径' -H '远程主机' -P '远程端口'
|
||||
```
|
||||
或者不借助 npm, 直接调用 deploy.js:
|
||||
```
|
||||
node deploy.js -p 远程登录密码' -k "用户私钥文件" -u '远程登录用户' -r '远程路径' -H '远程主机' -P '远程端口'
|
||||
```
|
||||
|
||||
5. `daemon` to launch web server on a TIC node host
|
||||
|
||||
登录到一台 TIC 节点主机,下载并进入代码目录,然后启动 web 服务:
|
||||
```
|
||||
npm run daemon
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -1,89 +0,0 @@
|
||||
|
||||
# Installation Guide of TIC Node Web
|
||||
星云节点.客户端(Web).安装指南
|
||||
|
||||
## GIT项目库导航
|
||||
* 返回根目录 [tic/node.console.web](https://git.faronear.org/tic/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/lib/lib.notes/src/master/JavaScript/nodejs.md>
|
||||
|
||||
+ git
|
||||
|
||||
+ For support on installing git, see <https://git.faronear.org/lib/lib.notes/src/master/VCS/git.md>
|
||||
|
||||
+ node.server
|
||||
|
||||
+ See <https://git.faronear.org/tic/node.server/src/master/doc/Installation.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. `lint` to format files
|
||||
|
||||
```
|
||||
npm run lint
|
||||
```
|
||||
|
||||
2. `dev` to test source code and 'hot-start' in a local web server
|
||||
|
||||
```
|
||||
npm run dev
|
||||
```
|
||||
|
||||
3. `dist` to pack source code into html/css/js for distribution
|
||||
|
||||
```
|
||||
npm run dist
|
||||
```
|
||||
|
||||
4. `deploy` to upload distribution to a TIC node host
|
||||
|
||||
```
|
||||
npm run deploy -- -p '远程登录密码' -k "用户私钥文件" -u '远程登录用户' -r '远程路径' -H '远程主机' -P '远程端口'
|
||||
```
|
||||
或者不借助 npm, 直接调用 deploy.js:
|
||||
```
|
||||
node deploy.js -p 远程登录密码' -k "用户私钥文件" -u '远程登录用户' -r '远程路径' -H '远程主机' -P '远程端口'
|
||||
```
|
||||
|
||||
5. `daemon` to launch web server on a TIC node host
|
||||
|
||||
登录到一台 TIC 节点主机,下载并进入代码目录,然后启动 web 服务:
|
||||
```
|
||||
npm run daemon
|
||||
```
|
||||
|
||||
## 4. References
|
||||
|
||||
+ 返回上级文档: <https://git.faronear.org/tic/node.console.web>
|
||||
+ 返回根文档: <https://git.faronear.org/tic/_tic/>
|
||||
Reference in New Issue
Block a user