用脚手架快速搭建现场文档及部署

# 搭建环境

# 安装相关软件

开发环境：nodejs (opens new window)
md编写工具：Typora (opens new window) (opens new window)；
Git：Git (opens new window)；
git提交工具：SourceTree (opens new window) (opens new window)/Tortoisegit (opens new window) (opens new window)等或者直接用git.sh脚本也可提交【可选】；

# 配置源

# 配置npm源

sudo npm i -g nrm --registry=https://registry.npm.taobao.org
nrm ls
nrm use taobao
npm i
# 或者直接通过taobao源安装；
npm i --registry=https://registry.npm.taobao.org

1
2
3
4
5
6

# 配置yarn源

sudo npm i -g yarn yrm --registry=https://registry.npm.taobao.org
yrm ls
yrm use taobao

1
2
3

# 安装脚手架

#nrm add bdp http://172.21.64.25:7373/
#nrm use bdp
sudo npm i -g bdp-cli --registry=http://172.21.64.25:7373/

1
2
3

如在安装过程中报权限错的话，需要加上 --unsafe-perm, 如下命令：

sudo npm i -g bdp-cli --unsafe-perm

# 初始化项目

如是第一次用bdp-cli, 在gitlab上生产访问令牌，替换本地~/.bdprc文件中的token; 可参考文档

要准备好四个设置内容：

项目名(en) 【hn-dx-deploy-doc】
项目描述【湖南电信部署文档】
项目标题【部署文档】
git项目地址【github.com/tmp】

通过脚手架初始化项目

➜  bdp-ztest bdp -V
1.1.3
➜  bdp-ztest bdp tpl install
✔ 获取repos中 
? 请选择要安装的repo? doc-tpl-bdp
⠋ 下载中 doc-tpl-bdp
Cloning into '/Users/samy/.bdp/tpl/doc-tpl-bdp'...
✔ 下载完成 doc-tpl-bdp
➜  bdp-ztest bdp init
? 请选择初始化的类型 initPro   初始化项目/Project
? 请输入 Project 名 hn-dx-deploy-doc
? 请选择模板文件哪个Project模板? doc-tpl-bdp
? 项目名(en) hn-dx-deploy-doc
? 项目描述 湖南电信部署文档
? 项目标题 部署文档
? git项目地址 github.com/tmp
✔ 👏生成完成 hn-dx-deploy-doc

  项目生成成功 hn-dx-deploy-doc, 然后进入目录安装依赖:
       $ cd hn-dx-deploy-doc && yarn install

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 编写文档

# 启动项目

cd hn-dx-deploy-doc && yarn install
yarn start

1
2

# 开始写作

创建文档项目后，用Typora打开进入docs目录下，在对应的目录下添加待编码前缀的文档或者文件；

参考文档

# 部署到ngx

# 配置ngx

设置ngx对应的静态路径

server {
  listen 8888;
  root /home/npm/deploy/doc/dist;
  index index.html index.htm index.nginx-debian.html;
  client_max_body_size 500M;
  proxy_connect_timeout       500s;
  proxy_send_timeout          500s;
  proxy_read_timeout          500s;
  send_timeout                500s;
  location / {
    try_files $uri $uri/ =404;
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13

# 发布部署

# scp部署

为了简化部署流程，直接通过scp拷贝部署；

~~方式一： sh deploy-ngx.sh~~

npm run build
scp -r dist/ npm@ip://home/npm/deploy/doc/dist
rm -rf dist

scp ./dist.zip root@10.45.xxx:/usr/lib/wdp-server/

1
2
3
4
5

方式二：参考用脚手架快速部署前端项目【推荐】不会暴露不必要的服务器信息；

部署配置json设置好后，运行命令部署：
```
"deploy": "bdp deploy"
# 配置好，zdeploy.js后再运行一下命令；
npm run deploy
#在选择要部署的环境；按照命令行提示部署；
```
1
2
3
4

# jks自动部署

执行shell

#cd /var/lib/jenkins/workspace/bdp-doc
cd $workspace
rm -rf dist
rm -f doc-doc.zip

npm install --registry=https://registry.npm.taobao.org
npm run build

zip -r bdp-doc.zip dist/

1
2
3
4
5
6
7
8
9

getbdpdoc.sh

#!/bin/bash
sleep 1
ftp  -niv  <<!
open  10.45.47.8x
user  xx  xx
binary
cd  /var/lib/jenkins/workspace/bdp-doc
lcd  /home/bdpcloud/doc
prompt
get  bdp-doc.zip
close
bye
!
sleep 1
pwd
ls -la

rm -rf bdp-doc
/usr/bin/unzip -d bdp-doc bdp-doc.zip
rm -f bdp-doc.zip
echo "解压成功"

#mv dist bdp-doc

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# 效果及教程

# 相关文档

https://my.samyz.cn/rat-skill/pages/cli-use/

https://my.samyz.cn/rat-skill/pages/online_md/

上次更新: 2023/11/17, 05:08:20

← 用脚手架快速部署前端项目现有基座及子系统→