docs:更新文档

This commit is contained in:
张益铭
2021-03-01 15:06:11 +08:00
parent 1542135ab0
commit 9064b372e8
5835 changed files with 904126 additions and 161722 deletions

View File

@@ -1,43 +1,17 @@
# Vue3.0版本已开发完成!
Vue3.0+TypeScript+NodeJS+MySql编写的一套后台管理框架
# 后端管理项目文档
## 文档地址
https://xiaoxian521.github.io/zh/standard/
## 安装依赖
```
npm install
```
## 结构介绍
① frontend为前端项目存放文件夹
② backend为后端项目存放文件夹
③ doc为文档编写存放文件夹
## 文档启动
```
npm run docs
```
## Structure introduction
① Frontend stores the folder for the front-end project
② Backend stores the folder for the back-end project
③ Doc write storage folder for documents
## 前端对应代码存放目录
vue => /frontend/vue-ts
react => /frontend/react-ts
angular => /frontend/angular-ts
## Front end corresponding code storage directory
vue => /frontend/vue-ts
react => /frontend/react-ts
angular => /frontend/angular-ts
## 注意点
① 接口文档使用Swagger
② 编写者必须严格遵守项目中tslint编写规则
③ 编写者必须严格遵循代码命名语义化、提高代码可读性
④ 编写者编写代码完毕必须经过单元测试,保证代码可用性
⑤ 编写必须完全使用TypeScript保证代码严谨性、可维护性
⑥ 编写者提交代码发生冲突必须先解决在推送严禁使用git push -f origin 分支
⑦ 编写者无须在项目中放置.gitignore文件如需加入别的git忽略请放在CURD-TS文件夹跟目录的.gitignore文件
## Attention point
① Interface documents use swagger
② The author must strictly abide by the tslint writing rules in the project
③ The author must strictly follow the code naming semantics and improve the readability of the code
④ The author must go through the unit test to ensure the usability of the code
⑤ Typescript must be used completely to ensure code rigor and maintainability
⑥ If the code submitted by the writer conflicts, it must be resolved first. In pushing, GIT push - f origin branch is strictly prohibited
⑦ The author does not need to place the. Gitignore file in the project. If you want to add other git ignore, please put it in the curd-ts folder and the. Gitignore file in the directory
## 文档打包
```
npm run docs:build
```
打包后会在.vitepress文件夹下生成dist目录