说明文档
This commit is contained in:
parent
a7ab300ae6
commit
4b37574544
36
README.en.md
36
README.en.md
|
|
@ -1,36 +0,0 @@
|
|||
# cutego
|
||||
|
||||
#### Description
|
||||
{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**}
|
||||
|
||||
#### Software Architecture
|
||||
Software architecture description
|
||||
|
||||
#### Installation
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### Instructions
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### Contribution
|
||||
|
||||
1. Fork the repository
|
||||
2. Create Feat_xxx branch
|
||||
3. Commit your code
|
||||
4. Create Pull Request
|
||||
|
||||
|
||||
#### Gitee Feature
|
||||
|
||||
1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
|
||||
2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
|
||||
3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
|
||||
4. The most valuable open source project [GVP](https://gitee.com/gvp)
|
||||
5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
|
||||
6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
||||
137
README.md
137
README.md
|
|
@ -1,25 +1,116 @@
|
|||
# cutego
|
||||
<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">CuteGo v1.0.0</h1>
|
||||
<h4 align="center">基于Gin、Xorm、Vue前后端分离的Go快速开发框架</h4>
|
||||
<p align="center">
|
||||
<a href="https://gitee.com/odboy/cutego/stargazers"><img src="https://gitee.com/odboy/cutego/badge/star.svg?theme=dark"></a>
|
||||
<a href="https://gitee.com/odboy/cutego/blob/master/LICENSE"><img src="https://img.shields.io/github/license/mashape/apistatus.svg"></a>
|
||||
</p>
|
||||
|
||||
#### 介绍
|
||||
{**以下是 Gitee 平台说明，您可以替换此简介**
|
||||
Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
|
||||
无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}
|
||||
CuteGo是一套全部开源的快速开发平台，毫无保留给个人及企业免费使用
|
||||
|
||||
* 前端采用Vue、Element UI
|
||||
* 后端采用Gin、Xorm、自定义RBAC、Redis & Jwt, 未使用Casbin
|
||||
|
||||
#### 软件架构
|
||||
软件架构说明
|
||||
1. 用户管理：系统用户配置
|
||||
2. 部门管理：配置系统组织机构（公司、部门、小组）, 树结构展现支持数据权限
|
||||
3. 岗位管理：配置系统用户所属担任职务
|
||||
4. 菜单管理：配置系统菜单, 操作权限, 按钮权限标识等
|
||||
5. 角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分
|
||||
6. 字典管理：对系统中经常使用的一些较为固定的数据进行维护
|
||||
7. 参数管理：对系统动态配置常用参数
|
||||
8. 定时任务：定时调度执行方法, 方法注册在 core/job/index.go
|
||||
|
||||
|
||||
#### 安装教程
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
- 1、安装golang运行环境
|
||||
|
||||
- 2、设置代理, 配置 GOPROXY 环境变量
|
||||
|
||||
```
|
||||
# 先执行
|
||||
go env -w GO111MODULE=on
|
||||
go env -w GOPROXY=https://goproxy.cn,direct
|
||||
```
|
||||
|
||||
- Bash (Linux or macOS)
|
||||
|
||||
```
|
||||
# 后执行
|
||||
export GOPROXY=https://goproxy.io,direct
|
||||
```
|
||||
|
||||
- PowerShell (Windows)
|
||||
|
||||
```
|
||||
# 后执行
|
||||
$env:GOPROXY = "https://goproxy.io,direct"
|
||||
```
|
||||
|
||||
- 3、将docs下的configs目录移动到cutego目录下
|
||||
|
||||
|
||||
- 4、idea配置如下
|
||||
|
||||
|
||||
- 5、下载依赖 go mod tidy
|
||||
|
||||
|
||||
#### 使用说明
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
1. 默认账号密码
|
||||
|
||||
```
|
||||
账号：admin 密码：123456
|
||||
```
|
||||
|
||||
2. 调整日志和文件存储路径
|
||||
|
||||
|
||||
|
||||
#### 编码顺序推荐
|
||||
|
||||
```
|
||||
[core] entity -> dao -> service -> api -> xx_router -> router
|
||||
|
||||
eg.
|
||||
[模块名称] entity -> dao -> service -> api -> router
|
||||
```
|
||||
|
||||
#### 交叉编译, 产出可执行程序
|
||||
|
||||
```
|
||||
# Mac 下编译 Linux 和 Windows 64位可执行程序
|
||||
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build main.go
|
||||
CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build main.go
|
||||
|
||||
# Linux 下编译 Mac 和 Windows 64位可执行程序
|
||||
CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build main.go
|
||||
CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build main.go
|
||||
|
||||
#Windows 下编译 Mac 和 Linux 64位可执行程序
|
||||
SET CGO_ENABLED=0
|
||||
SET GOOS=darwin
|
||||
SET GOARCH=amd64
|
||||
go build main.go
|
||||
|
||||
SET CGO_ENABLED=0
|
||||
SET GOOS=linux
|
||||
SET GOARCH=amd64
|
||||
go build main.go
|
||||
|
||||
# GOOS：目标平台的操作系统（darwin、freebsd、linux、windows）
|
||||
# GOARCH：目标平台的体系架构（386、amd64、arm）
|
||||
# 交叉编译不支持 CGO 所以要禁用它
|
||||
|
||||
# 上面的命令编译的是 64 位可执行程序，当然你也可以使用 386 编译 32 位可执行程序
|
||||
|
||||
# 注意!!
|
||||
windows下面 PowerShell不行，要CMD
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### 参与贡献
|
||||
|
||||
|
|
@ -28,12 +119,22 @@ Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN
|
|||
3. 提交代码
|
||||
4. 新建 Pull Request
|
||||
|
||||
#### 感谢（排名不分先后）
|
||||
|
||||
#### 特技
|
||||
- in框架 [https://github.com/gin-gonic/gin](https://github.com/gin-gonic/gin)
|
||||
|
||||
1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
|
||||
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
|
||||
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
|
||||
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
|
||||
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
|
||||
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
||||
- gotool [https://github.com/druidcaesa/gotool](https://github.com/druidcaesa/gotool)
|
||||
|
||||
- RuoYi-Vue [https://gitee.com/y_project/RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue)
|
||||
|
||||
- Jwt-go [https://github.com/dgrijalva/jwt-go](https://github.com/dgrijalva/jwt-go)
|
||||
|
||||
- excelize [https://github.com/qax-os/excelize](https://github.com/qax-os/excelize)
|
||||
|
||||
- xorm [https://github.com/go-xorm/xorm](https://github.com/go-xorm/xorm)
|
||||
|
||||
- 纯真IP库 [https://www.cz88.net/](https://www.cz88.net/)
|
||||
|
||||
- robfig/cron定时任务框架 [https://pkg.go.dev/github.com/robfig/cron?utm_source=godoc](https://pkg.go.dev/github.com/robfig/cron?utm_source=godoc)
|
||||
|
||||
#### 如果对你学习或工作有帮助，请给一个小小的star
|
||||
|
|
|
|||
Loading…
Reference in New Issue