docs: 文档更新

CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# 开发要求
+
+## 我们的目标
+
+为了高效、高质量的完成项目交付目标。
+
+## 我们的标准
+有助于提高编码效率和质量的行为包括:
+
+- 1、遵守开发规范。
+- 2、使用eslint+Prettier自动修复代码
+- 3、代码行文尽量整洁规整。业务逻辑简洁、清晰。
+- 4、核心业务上必须要有注释，头部需要有注释便与溯源。
+- 5、公共组件开发需要记录文档且注释丰富。
+- 6、问题及细节需要有共享文档进行团队同步。
+- 7、阶段性的代码评审，整体回顾。
+- 8、提测前需要自测和交叉测试。
+
+不可以接受的行为包括:
+
+- 1、独狼行为，忽视团队的开发规范和开发要求。
+- 2、不自测的代码进行提测。
+- 3、无用的代码不删除，代码行文和逻辑冗余邋遢。
+- 4、对于细节及漏洞不用心对待，存在侥幸心理。
+- 5、恶意违反公司及团队规则。
+
+一个人的力量始终是有限的，只有在团队中才能更好的发光发热，才完成更大的目标。
+保持对前端的热爱和新技术的追求。
+始终有对自己有要求，写的代码如诗歌一般优美。
+
+
+## 代码评审准则
+
+- 1、是否遵守开发规范和开发要求。
+- 2、核心功能是否有缺陷。
+- 3、页面是否有缺陷。
+- 4、细节是否完善、整体代码行文。
+- 5、业务逻辑和代码细节是否合理。
+
+## 相关文档
+
+- 前端通用开发规范 [http://172.18.7.186:8181/read/team/prefix_59454ed663cdb4bb8d542c1967a62056.md]
+

README.md

@@ -1,13 +1,32 @@
-# vue3-element-admin
+## 简介
 
 这个模板使用了最新的 vue3 和 element-plus UI 框架，vite 构建工具、pinia 状态管理、vue-router 路由管理、mockjs 数据模拟，并集成了 typescript。功能从 Vue Element Admin 移植而来，详细使用可以参考[该文档](https://vue3-element-admin-site.midfar.com/zh/guide/essentials/router-and-nav.html)。
 
-# 在线示例
+## 特性
+
+- **最新技术栈**：使用 Vue3/vite3 等前端前沿技术开发
+- **TypeScript**: 应用程序级 JavaScript 的语言
+- **Mock 数据** 内置 Mock 数据方案
+- **权限** 内置完善的动态路由权限生成方案
+- **组件** 二次封装了多个常用的组件
+
+## 在线示例
 
 [vue3 element admin](https://vue3-element-admin.midfar.com/)
 
 [element plus](https://element-plus.midfar.com/)
 
+## 准备
+开发前请确保熟悉并掌握以下技术栈：
+
+- vue: https://cn.vuejs.org/
+- TypeScript：https://www.tslang.cn/index.html
+- element-plus：https://element-plus.gitee.io/zh-CN/
+- pinia: https://pinia.web3doc.top/
+- vue-router: https://router.vuejs.org/zh/
+
+注：开发前请务必阅读上述所有文档。应用至实际项目开发请修改 readme 内容。
+
 ## 推荐的 IDE 工具和插件
 
 [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (禁用 Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
@@ -16,7 +35,29 @@
 
 参考 [Vite 配置](https://vitejs.dev/config/).
 
-## 安装依赖
+## 主要结构
+
+```
+- mock // 模拟数据
+- public
+- src
+  - components // 组件
+  - views // 页面
+    - tableTemplates // 示例模块
+	  - index.ts
+   - login // 登录模块
+	  - index.vue
+ - settings.ts // 全局配置
+ - main.ts // 入口文件
+-  types // TypeScript类型
+- package.json
+- CODE_OF_CONDUCT.md // 框架开发要求
+- README.md //框架使用手册
+```
+
+## 使用
+
+### 安装依赖
 
 ```sh
 npm install
@@ -40,14 +81,25 @@ npm run build:test
 npm run lint
 ```
 
-### 捐赠
+## 支持环境
 
-如果你觉得这个项目帮助到了你，你可以帮作者买一杯果汁表示鼓励 :tropical_drink:
+现代浏览器。
 
-wechat: midfar-sun
+| IE/Edge          | Firefox         | Chrome          | Safari          | 
+| ---------------- | --------------- | --------------- | --------------- | 
+| IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions | 
 
-## License
+## TODO
 
-[MIT](https://opensource.org/licenses/MIT)
+当前问题
 
-Copyright (c) 2022-present, Midfar Sun
+- 暂未配置git提交规范。
+
+## 参与贡献
+
+我们非常欢迎你的贡献，你可以通过以下方式和我们一起共建基线框架：
+
+- 联系维护人员。梁志远 liangzhiyuan001@chinasoftinc.com、冯超 fengchao008@chinasoftinc.com。
+- 提交 pr。
+- 修复 bug。
+- 分享实践案例。