diff --git a/README.md b/README.md index ed3da2e..4f46fe7 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,3 @@ -# console +# node.console.web -## Project setup -``` -npm install -``` - -### Compiles and hot-reloads for development -``` -npm run dev -``` - -### Compiles and minifies for production -``` -npm run dist -``` - -### Compiles and minifies for production -``` -npm run deploy -- -H 待部署主机的IP或域名 -r 待部署主机上的路径 -u 用户名 -p 密码 -``` - -### Run your tests -``` -npm run test -``` - -### Lints and fixes files -``` -npm run lint -``` - -### Run your unit tests -``` -npm run test:unit -``` +[Installation Guide](./doc/Installation.md) \ No newline at end of file diff --git a/doc/Installation.md b/doc/Installation.md new file mode 100644 index 0000000..6face23 --- /dev/null +++ b/doc/Installation.md @@ -0,0 +1,78 @@ + +# Installation Guide of node.console.web + +配合 node.server 的前端界面。 + +## Table of Contents + + 1. [System requirements](#1-system-requirements) + 2. [Preparation](#2-preparation) + 3. [Launch](#3-launch) + +## 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 stable +``` + +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 '远程密码' -u '用户名' -r '远程路径' -H '远程主机' + ``` + +5. `run daemon` to launch web server on remote host + + 登录到远程主机,进入 node.console.web 目录,然后 + ``` + npm run daemon + ``` + 启动 web 服务。