[Development Steps](https://www.gin-vue-admin.com/docs/help) (Contributor: <ahref="https://github.com/LLemonGreen">LLemonGreen</a> And <ahref="https://github.com/fkk0509">Fann</a>)
- Web UI Framework：[element-ui](https://github.com/ElemeFE/element)
- Server Framework：[gin](https://github.com/gin-gonic/gin)
[开发教学](https://www.gin-vue-admin.com/docs/help) (贡献者: <ahref="https://github.com/LLemonGreen">LLemonGreen</a> And <ahref="https://github.com/fkk0509">Fann</a>)
> Gin-vue-admin is a full-stack (frontend and backend separation) framework designed for management system.
> It integrates multiple functions, such as JWT authentication, dynamic routing, dynamic menu, casbin authentication, form generator, code generator, etc. So that you can focus more time on your business Requirements.
We are excited that you are interested in contributing to gin-vue-admin. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
- Issues are exclusively for bug reports, feature requests and design-related topics. Other questions may be closed directly. If any questions come up when you are using Element, please hit [Gitter](https://gitter.im/element-en/Lobby) for help.
- 在提交 issue 之前，请搜索相关内容是否已被提出。
- Before submitting an issue, please check if similar problems have already been issued.
- After you clone the project, use the scripts in directory db to create your own database.
- We recommend you to apply for your own cloud service in QINIU. Replace the public key, private key, warehouse name and default url address with your own, so as not to mess up the test database.
```
### 2.1 Web
### 2.1 web端
```bash
# clone the project
@ -133,192 +131,186 @@ npm install
npm run serve
```
### 2.2 Server
### 2.2 server端
```bash
# using go.mod
# 使用 go.mod
# install go modules
# 安装go依赖包
go list (go mod tidy)
# build the server
# 编译
go build
```
### 2.3 API docs auto-generation using swagger
### 2.3 swagger自动化API文档
#### 2.3.1 install swagger
#### 2.3.1 安装 swagger
##### (1) Using VPN or outside mainland China
##### （1）可以翻墙
````
go get -u github.com/swaggo/swag/cmd/swag
````
##### (2) In mainland China
In mainland China, access to go.org/x is prohibited，we recommend [goproxy.io](https://goproxy.io/zh/)
After executing the above command，`docs` will show in `server/`，then open your browser, jump into `http://localhost:8888/swagger/index.html` to see the swagger APIs.
│ ├─resource （resources, such as static pages, templates）
│ ├─router （routers）
│ ├─service (services)
│ └─utils （common utilities）
└─web （frontend）
├─public （deploy templates）
└─src （source code）
├─api （frontend APIs）
├─assets （static files）
├─components（components）
├─router （frontend routers）
├─store （vuex state management）
├─style （common styles）
├─utils （frontend common utilitie）
└─view （pages）
├─server （后端文件夹）
│ ├─api （API）
│ ├─config （配置包）
│ ├─core （內核）
│ ├─db （数据库脚本）
│ ├─docs （swagger文档目录）
│ ├─global （全局对象）
│ ├─initialiaze （初始化）
│ ├─middleware （中间件）
│ ├─model （结构体层）
│ ├─resource （资源）
│ ├─router （路由）
│ ├─service (服务)
│ └─utils （公共功能）
└─web （前端文件）
├─public （发布模板）
└─src （源码包）
├─api （向后台发送ajax的封装层）
├─assets （静态文件）
├─components（组件）
├─router （前端路由）
├─store （vuex 状态管理仓）
├─style （通用样式文件）
├─utils （前端工具库）
└─view （前端页面）
```
## 5. Features
- Authority management: Authority management based on `jwt` and `casbin`.
- File upload & download: File upload operation based on Qiniu Cloud (In order to make it easier for everyone to test, I have provided various important tokens of my Qiniu test number, and I urge you not to make things a mess).
- Pagination Encapsulation：The frontend uses mixins to encapsulate paging, and the paging method can call mixins
- User management: The system administrator assigns user roles and role permissions.
- Role management: Create the main object of permission control, and then assign different API permissions and menu permissions to the role.
- Menu management: User dynamic menu configuration implementation, assigning different menus to different roles.
- API management: Different users can call different API permissions.
- Configuration management: The configuration file can be modified in the web page (the test environment does not provide this function).
- Rich text editor: Embed MarkDown editor function.
- Conditional search: Add an example of conditional search.
- Restful example: You can see sample APIs in user management module.
- Multi-login restriction: Change `userMultipoint` to true in `system` in `config.yaml` (You need to configure redis and redis parameters yourself. During the test period, please report in time if there is a bug).
- Upload file by chunk：Provides examples of file upload and large file upload by chunk.
- Form Builder：With the help of [@form-generator](https://github.com/JakHuang/form-generator).
- Code generator: Providing backend with basic logic and simple curd code generator.
>There are video courses about frontend framework in our blo. If you think the project is helpful to you, you can add my personal WeChat:shouzi_1994，your comments is welcomed。
pixel
4 years ago