🐉 重新构筑

Author: eryajf

.env.example

@@ -4,13 +4,21 @@
 *.dll
 *.so
 *.dylib
+.idea
+.vscode
+.token
+
+build.sh
+logs
+xirang
 
 # Test binary, built with `go test -c`
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
-.env
-eryajfgo
-.vscode
-.idea
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+tmp
+docs/docker-compose/data

.gitignore

@@ -0,0 +1,17 @@
+FROM golang:1.17.10 AS builder
+
+# ENV GOPROXY      https://goproxy.io
+
+RUN mkdir /app
+ADD . /app/
+WORKDIR /app
+RUN sed -i 's@localhost:389@openldap:389@g' /app/config.yml \
+    && sed -i 's@host: localhost@host: mysql@g'  /app/config.yml && go build -o xirang .
+
+FROM centos:centos7
+RUN mkdir /app
+WORKDIR /app
+COPY --from=builder /app/ .
+RUN chmod +x wait xirang && yum -y install vim net-tools telnet wget curl && yum clean all
+
+CMD ./wait && ./xirang

Dockerfile

@@ -1,7 +1,16 @@
 default: build
 
+run:
+	GIN_MODE=release go run main.go
+
 build:
 	go build -o xirang main.go
 
 build-linux:
-	CGO_ENABLED=0 GOARCH=amd64 GOOS=linux go build -o xirang main.go
+	CGO_ENABLED=0 GOARCH=amd64 GOOS=linux go build -o xirang main.go
+
+build-linux-arm:
+	CGO_ENABLED=0 GOARCH=arm64 GOOS=linux go build -o xirang main.go
+
+lint:
+	env GOGC=25 golangci-lint run --fix -j 8 -v ./...

LICENSE

@@ -1,14 +1,26 @@
+<div align="center">
+
 <h1 align="center">XiRang</h1>
 
-<div align="center">
-简单好用，不缠不绕，直接上手的go-web框架
+[![Auth](https://img.shields.io/badge/Auth-eryajf-ff69b4)](https://github.com/eryajf)
+[![Go Version](https://img.shields.io/github/go-mod/go-version/eryajf/xirang)](https://github.com/eryajf/xirang)
+[![Gin Version](https://img.shields.io/badge/Gin-1.6.3-brightgreen)](https://github.com/eryajf/xirang)
+[![Gorm Version](https://img.shields.io/badge/Gorm-1.20.12-brightgreen)](https://github.com/eryajf/xirang)
+[![GitHub Issues](https://img.shields.io/github/issues/eryajf/xirang.svg)](https://github.com/eryajf/xirang/issues)
+[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/eryajf/xirang)](https://github.com/eryajf/xirang/pulls)
+[![GitHub Pull Requests](https://img.shields.io/github/stars/eryajf/xirang)](https://github.com/eryajf/xirang/stargazers)
+[![HitCount](https://views.whatilearened.today/views/github/eryajf/xirang.svg)](https://github.com/eryajf/xirang)
+[![GitHub license](https://img.shields.io/github/license/eryajf/xirang)](https://github.com/eryajf/xirang/blob/main/LICENSE)
+
+<p> 🦖 简单好用，不缠不绕，直接上手的go-web框架 </p>
+
+<img src="https://camo.githubusercontent.com/82291b0fe831bfc6781e07fc5090cbd0a8b912bb8b8d4fec0696c881834f81ac/68747470733a2f2f70726f626f742e6d656469612f394575424971676170492e676966" width="800"  height="3">
+</div><br>
+
 <p align="center">
-<img src="https://img.shields.io/github/go-mod/go-version/eryajf/xirang" alt="Go version"/>
-<img src="https://img.shields.io/badge/Gin-1.6.3-brightgreen" alt="Gin version"/>
-<img src="https://img.shields.io/badge/Gorm-1.22.3-brightgreen" alt="Gorm version"/>
-<img src="https://img.shields.io/github/license/eryajf/xirang" alt="License"/>
+  <a href="" rel="noopener">
+ <img src="https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220826_101156.png" alt="Project logo"></a>
 </p>
-</div>
 
 
 >`xirang`，亦即息壤，大概在我读小学时，父亲从外地回来，并带回来几本读物，其中一本是迅哥儿小时候最爱读的《山海经》，也是在那时，我第一次认识这个词语。
@@ -19,28 +31,65 @@
 
 ## 项目介绍
 
-[gitee地址](https://gitee.com/eryajf/xirang): https://gitee.com/eryajf/xirang
+`xirang` 是一个非常简单的 `gin+gorm` 框架的基础架构，你只需要修改简单的代码，即可开始上手编写你的接口。
 
-`xirang` 是一个非常简单的 `gin+gorm` 框架的基础架构，你只需要修改简单的代码，即可开发出你想要的接口。
-
-只需要将`.env.example`改为`.env`，然后配置里边的数据库配置信息，即可开始开发。
+只需要根据情况修改配置`config.yml`，然后配置里边的数据库配置信息，即可开始开发。
 
 数据表会自动创建，也可以通过docs下的sql自行创建。
 
-## 重构更新
-
-将gorm更新到v2版本，优化了项目初始化逻辑，优化了整体的内容，废除掉一些不必要的内容。
-
 ## 目录结构
 
 ```
 xirang
-├── controller----------------控制层
-├── docs----------------------提供的原料信息
-├── main.go-------------------入口文件
-├── middleware----------------中间件
-├── model---------------------对象定义
-├── public--------------------一些公共组件
-├── router--------------------路由
-└── service-------------------服务层
-```
+├── config----------------配置文件读取
+├── controller------------控制层
+├── logic-----------------逻辑层
+├── middleware------------中间件
+├── model-----------------对象定义
+├── public----------------一些公共组件与工具
+├── routers---------------路由
+├── service---------------服务层
+├── test------------------一些测试
+├── config.yml------------配置文件
+└── main.go---------------程序入口
+```
+
+## 快速开始
+
+xirang项目的基础依赖项只有MySQL，本地准备好这两个服务之后，就可以启动项目，进行调试。
+
+### 拉取代码
+
+```sh
+# 后端代码
+$ git clone https://github.com/eryajf/xirang.git
+
+# 前端代码
+$ git clone https://github.com/eryajf/xirang-ui.git
+```
+
+### 更改配置
+
+```sh
+# 修改后端配置
+$ cd xirang
+# 文件路径 config.yml, 根据自己本地的情况，调整数据库等配置信息。
+$ vim config.yml
+```
+
+### 启动服务
+
+```sh
+# 启动后端
+$ cd xirang
+$ go mod tidy
+$ make run
+
+# 启动前端
+$ cd xirang-ui
+$ git config --global url."https://".insteadOf git://
+$ npm install --registry=http://registry.npmmirror.com
+$ yarn dev
+```
+
+本地访问：http://localhost:8090，用户名/密码：admin/123456

Makefile

@@ -0,0 +1,73 @@
+# delelopment
+system:
+  # 设定模式(debug/release/test,正式版改为release)
+  mode: debug
+  # url前缀
+  url-path-prefix: api
+  # 程序监听端口
+  port: 8888
+  # 是否初始化数据(没有初始数据时使用, 已发布正式版改为false)
+  init-data: true
+  # rsa公钥文件路径(config.yml相对路径, 也可以填绝对路径)
+  rsa-public-key: xirang-pub.pem
+  # rsa私钥文件路径(config.yml相对路径, 也可以填绝对路径)
+  rsa-private-key: xirang-priv.pem
+
+logs:
+  # 日志等级(-1:Debug, 0:Info, 1:Warn, 2:Error, 3:DPanic, 4:Panic, 5:Fatal, -1<=level<=5, 参照zap.level源码)
+  level: -1
+  # 日志路径
+  path: logs
+  # 文件最大大小, M
+  max-size: 50
+  # 备份数
+  max-backups: 100
+  # 存放时间, 天
+  max-age: 30
+  # 是否压缩
+  compress: false
+
+mysql:
+  # 用户名
+  username: root
+  # 密码
+  password: 123456
+  # 数据库名
+  database: go_ldap_admin
+  # 主机地址
+  host: localhost
+  # 端口
+  port: 3306
+  # 连接字符串参数
+  query: parseTime=True&loc=Local&timeout=10000ms
+  # 是否打印日志
+  log-mode: true
+  # 数据库表前缀(无需再末尾添加下划线, 程序内部自动处理)
+  table-prefix: tb
+  # 编码方式
+  charset: utf8mb4
+  # 字符集(utf8mb4_general_ci速度比utf8mb4_unicode_ci快些)
+  collation: utf8mb4_general_ci
+
+# casbin配置
+casbin:
+  # 模型配置文件, config.yml相对路径
+  model-path: 'rbac_model.conf'
+
+# jwt配置
+jwt:
+  # jwt标识
+  realm: test jwt
+  # 服务端密钥
+  key: secret key
+  # token过期时间, 小时
+  timeout: 12000
+  # 刷新token最大过期时间, 小时
+  max-refresh: 12000
+
+# 令牌桶限流配置
+rate-limit:
+  # 填充一个令牌需要的时间间隔,毫秒
+  fill-interval: 50
+  # 桶容量
+  capacity: 200