开发、构建及部署说明¶
基本说明¶
本文档中所有的说明和示例都以Linux
为例,实际的开发和部署适用于Windows
和Mac
。
项目依赖¶
软件 | 说明 | 开发依赖 | 部署依赖 |
---|---|---|---|
Apache HTTP Server | 静态文件服务器 | no | yes |
Python | MkDocs运行时 | yes | no |
MkDocs | 生成文档页面 | yes | no |
Node.js | 项目编译及样式主题制作器Web应用运行时 | yes | yes |
服务器¶
服务器环境¶
主机 | 用户名 | 密码 |
---|---|---|
10.108.7.58 | root | ABC@1234 |
Apache HTTP Server配置和常用命令¶
Apache HTTP Server
配置文件路径/etc/httpd/conf/httpd.conf
配置文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | Listen 80 listen 8080 <VirtualHost *:80> DocumentRoot "/var/www/html" Alias "/docs" "/var/www/docs" Alias "/app" "/var/www/bootstrap-magic/app" Alias "/download" "/var/www/download" <Directory "/var/www/docs"> DirectoryIndex index.html </Directory> <Directory "/var/www/html/site"> DirectoryIndex index.html </Directory> <Directory "/var/www/bootstrap-magic/app"> DirectoryIndex index.html </Directory> </VirtualHost> <VirtualHost *:8080> DocumentRoot "/var/www/dev" Alias "/docs" "/var/www/docs" Alias "/app" "/var/www/bootstrap-magic/app" Alias "/download" "/var/www/download" <Directory "/var/www/docs"> DirectoryIndex index.html </Directory> <Directory "/var/www/dev/site"> DirectoryIndex index.html </Directory> <Directory "/var/www/bootstrap-magic/app"> DirectoryIndex index.html </Directory> </VirtualHost> # 禁用缓存配置 <IfModule mod_headers.c> Header set Cache-Control "max-age=0, no-cache, no-store, must-revalidate" Header set Pragma "no-cache" Header set Expires 0 </IfModule> |
修改配置文件后重启服务器
1 | service httpd restart |
UI Tools¶
项目主页¶
需知
分支不同,项目的本地开发、编译和构建命令一致。
本地开发¶
安装依赖
1 | npm install |
本地开发
1 | npm run build:dev |
构建¶
1 | npm run build:prod |
提示
构建和本地开发命令的不同在于构建会压缩本地开发生成的代码,减少网络传输中文件的大小。
部署¶
目前的部署是在服务器端进行构建。后期可以根据实际需要,调整部署流程。
UI Tools程序版¶
项目主页¶
本地开发¶
安装依赖
1 | npm install |
监控模式启动前端项目
1 | npm run watch:client |
监控模式启动服务器端项目
1 | npm run watch:server |
编译和打包¶
生成可执行文件
1 | npm run pkg |
压缩可执行文件和配置文件
1 | npm run zip:bin |
压缩程序和前端依赖文件
1 | npm run zip:all |
程序发布¶
本地编译打包后,可以将程序发布到服务器的/var/www/download
路径,通过不同的路径名区分不同的版本,并在文档中的程序版CHANGELOG中更新对应版本的路径。
样式主题制作器¶
项目主页¶
本地开发¶
安装依赖
1 | npm install |
本地开发
1 | node server.js |
构建¶
部署¶
启动
1 | npm run start |
关闭
1 | npm run stop |
重启
1 | npm run restart |
提示
点击pm2了解更多有关npm
脚本中用到的pm2
命令。
文档¶
项目主页¶
文档制作器主页MkDocs
文档主题样式主页Material for MkDocs
提示
文档位于UI Tools项目的master
分支中的docs
目录。
本地开发¶
1 | pip install mkdocs |
- 安装文档主题Material for MkDocs
1 | pip install mkdocs-material |
- 本地生成文档页面
1 | npm run docs:dev |
构建¶
1 | npm run docs:build |
部署¶
拷贝构建后生成的site
目录中的文件到服务器/var/www/docs
目录。