mirror of
https://github.com/pure-admin/vue-pure-admin.git
synced 2025-11-21 14:13:36 +08:00
docs:更新文档
This commit is contained in:
32
docs/zh/introduction/contributor.md
Normal file
32
docs/zh/introduction/contributor.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# 贡献者
|
||||
|
||||
:tada: :100:
|
||||
::: tip
|
||||
```
|
||||
和尚
|
||||
```
|
||||
GitHub:https://github.com/xiaoxian521
|
||||
:::
|
||||
|
||||
:tada: :100:
|
||||
::: tip
|
||||
```
|
||||
chenxi
|
||||
```
|
||||
GitHub:https://github.com/chenxi19950223/wxnode
|
||||
:::
|
||||
|
||||
:tada: :100:
|
||||
::: tip
|
||||
```
|
||||
ChaoSuperScholar
|
||||
```
|
||||
GitHub:https://github.com/ChaoSuperScholar/smallhouse
|
||||
:::
|
||||
|
||||
:tada: :100:
|
||||
::: tip
|
||||
```
|
||||
Yinwenxu
|
||||
```
|
||||
:::
|
||||
8
docs/zh/introduction/description.md
Normal file
8
docs/zh/introduction/description.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# 项目描述
|
||||
|
||||
### 一套整体基于TS的增删改查系统
|
||||
|
||||
## 主要技术:
|
||||
| 前端 | 后端 | 数据库 |
|
||||
| -- |:--:| -- |
|
||||
| Vue3.0、React、Angular | Node | MySQL、MongoDB、SQlite |
|
||||
BIN
docs/zh/introduction/images/bg.png
Normal file
BIN
docs/zh/introduction/images/bg.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/zh/introduction/images/login.png
Normal file
BIN
docs/zh/introduction/images/login.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/zh/introduction/images/register.png
Normal file
BIN
docs/zh/introduction/images/register.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 541 KiB |
23
docs/zh/introduction/openSource.md
Normal file
23
docs/zh/introduction/openSource.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# 开源精神
|
||||
|
||||
## 为什么要为开源做贡献?
|
||||
|
||||
### 巩固现有技能
|
||||
无论是撰写代码、设计用户界面、图形设计、撰写文档、亦或是组织活动,假如你有实践的愿望,你总能在开源项目中找到自己的位置。
|
||||
|
||||
### 遇见那些和你”臭味相投”的人
|
||||
开源项目一般都会有一个和谐、热心的社区,以让大家团结一致。实际上,开源界经常发生这样的情形,很多人的深厚友谊都是通过共同参与开源所建立起来的,至于具体的方式,可能是在一次技术研讨会上相谈甚欢,也可能是一直在聊天室中探讨问题。
|
||||
|
||||
### 寻找导师,并且尝试帮助他人
|
||||
和他人共同在一个共享的项目下工作,这意味着需要向他人解释清楚自己是如何做的,同理,也需要向他人求助,询问别人是如何做的。相互学习和彼此教学对于每位参与者都能满载而归。
|
||||
|
||||
### 在公众间建立你的声誉(职业口碑)
|
||||
根据开源的定义,你在开源下所有的工作都是公开的,这也就意味着开源项目是一个很好展示你实力的地方。
|
||||
|
||||
### 学习领导和管理的艺术
|
||||
开源为实践领导力和管理技能提供了很好的机会,比如解决冲突、组织团队、工作的优先级排列。
|
||||
|
||||
### 鼓励作出改变,哪怕改变是很微小的
|
||||
在开源的世界里,作出贡献的不一定非得是花了很长时间拥有大量经验的人。你是否遇到过浏览某些网站发现有拼写错误,希望有人能修改它?其实,在开源的项目中,你只需要做就可以了。没有那么多的顾忌,开源让人们在很舒服的状态做事,而这才是这个世界应有的体验。
|
||||
|
||||
### 关于开源精神你可以来这里学习:http://opensource.guide/zh-hans/
|
||||
15
docs/zh/introduction/ui.md
Normal file
15
docs/zh/introduction/ui.md
Normal file
@@ -0,0 +1,15 @@
|
||||
## UI规范
|
||||
#### 1. 一款好的“产品”体现了您的文化、审美底蕴,哈哈,尽量页面效果统一! :grin:
|
||||
#### 2. 使用统一的icon,我会拉你们进对应的iconfont项目! :kissing_heart:
|
||||
|
||||
## 设计图
|
||||
|
||||

|
||||
#### 背景图(可右键另存为图片)
|
||||

|
||||
#### 登录页
|
||||

|
||||
#### 注册页
|
||||
|
||||
## 项目参考地址(UI外观)
|
||||
http://beautiful.panm.cn/vue-admin-beautiful-pro/?hmsr=github&hmpl=&hmcu=&hmkw=&hmci=#/login?redirect=%2Findex
|
||||
BIN
docs/zh/plugs/images/hyper.gif
Normal file
BIN
docs/zh/plugs/images/hyper.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 243 KiB |
BIN
docs/zh/plugs/images/snip.gif
Normal file
BIN
docs/zh/plugs/images/snip.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 252 KiB |
38
docs/zh/plugs/index.md
Normal file
38
docs/zh/plugs/index.md
Normal file
@@ -0,0 +1,38 @@
|
||||
## 1. VsCode插件
|
||||
|
||||
请安装TSLint、Vetur、vscode-icons、ES7 React
|
||||
|
||||
## 2. VsCode快速生成代码片段
|
||||
Ctrl+Shift+P 选中配置用户代码片段 搜索vue.json,将下面代码复制进去,在.vue文件输入vue回车即可
|
||||
```
|
||||
{
|
||||
"Vue3.0快速生成模板": {
|
||||
"prefix": "Vue3.0",
|
||||
"body": [
|
||||
"<template>",
|
||||
"\t<div>\n",
|
||||
"\t</div>",
|
||||
"</template>\n",
|
||||
"<script lang='ts'>",
|
||||
"export default {",
|
||||
"\tsetup(){",
|
||||
"\t\treturn{\n\n\t\t}",
|
||||
"\t},",
|
||||
"}",
|
||||
"</script>\n",
|
||||
"<style scoped>\n",
|
||||
"</style>",
|
||||
"$2"
|
||||
],
|
||||
"description": "Vue3.0"
|
||||
}
|
||||
}
|
||||
```
|
||||

|
||||
|
||||
## 3. hyper
|
||||
|
||||

|
||||
|
||||
一款美化命令面板插件,基于TS,版本:windows、mac、linux
|
||||
下载地址:https://hyper.is/#installation
|
||||
16
docs/zh/standard/index.md
Normal file
16
docs/zh/standard/index.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# 书写规范
|
||||
|
||||
:tada: :100:
|
||||
::: tip
|
||||
① 接口文档使用Swagger
|
||||
② 编写者必须严格遵守项目中tslint编写规则
|
||||
③ 编写者必须严格遵循代码命名语义化、提高代码可读性
|
||||
④ 编写者编写代码完毕必须经过单元测试,保证代码可用性
|
||||
⑤ 编写必须完全使用TypeScript,保证代码严谨性、可维护性
|
||||
⑥ 编写者提交代码发生冲突,必须先解决,在推送,严禁使用git push -f origin 分支
|
||||
⑦ vue代码请放在vue-ts分支下,react代码请放在react-ts分支下,angular代码请放在angular-ts分支下
|
||||
:::
|
||||
|
||||
::: danger
|
||||
管理者严禁将代码直接推送或合并到main分支,main分支只用来存放后端代码和文档代码,这样避免了首次拉取代码需要等很长时间,代码整体编写完毕后会合并到main分支
|
||||
:::
|
||||
Reference in New Issue
Block a user