update: README.md & deploy

Author: basefas

.github/workflows/docker-publish.yml

@@ -19,28 +19,28 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # Workaround: https://github.com/docker/build-push-action/issues/461
       - name: Setup Docker buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
 
       - name: Log into registry ${{ env.REGISTRY }}
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GHCR_PAT }}
 
       - name: Extract Docker metadata
         id: meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v4
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
       - name: Build and push Docker image
         id: build-and-push
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v4
         with:
           context: .
           file: ./deploy/docker/chn.Dockerfile

Makefile

@@ -1,7 +1,7 @@
 .PHONY: run build
 
 # $(shell git rev-parse --short HEAD)
-VERSION := 0.0.3
+VERSION := 0.1.0
 
 run:
 	go run ./cmd/app/main.go

README.md

@@ -1,2 +1,103 @@
-# admin-go
-A Management System powered by Go.
+<!-- PROJECT SHIELDS -->
+[![LICENSE](https://img.shields.io/github/license/basefas/admin-go.svg?style=flat-square)](/LICENSE)
+[![Releases](https://img.shields.io/github/release/basefas/admin-go/all.svg?style=flat-square)](https://github.com/basefas/admin-go/releases)
+![GitHub Repo stars](https://img.shields.io/github/stars/basefas/admin-go?style=social)
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a>
+    <img src="https://raw.githubusercontent.com/basefas/files/main/logo.svg" alt="Logo" width="80" height="80">
+  </a>
+
+<h3 align="center">admin-go</h3>
+
+  <p align="center">
+     一个使用 Go 语言开发的管理系统
+    <br />
+  </p>
+</div>
+
+<!-- Introduction -->
+
+## 简介
+
+admin 使用 Go & Gin & Gorm 开发，包含常用后台使用的基本模块，同时提供完整功能的前端程序，可快速用于二次开发及功能扩展。
+
+
+|           | url                                         | introduction                               |
+|-----------|---------------------------------------------|--------------------------------------------|
+| backend   | https://github.com/basefas/admin-go         | 使用 Go & Gin 开发的后台管理系统后端           |
+| frontend  | https://github.com/basefas/react-antd-admin | 使用 react & vite & antd 开发的后台管理系统前端|
+
+
+## 页面截图
+
+### 登录页面
+
+![Screen Shot](https://github.com/basefas/files/blob/main/login.png)
+
+### 用户管理
+
+![Screen Shot](https://github.com/basefas/files/blob/main/user.png)
+
+### 分组管理
+
+![Screen Shot](https://github.com/basefas/files/blob/main/group.png)
+
+### 菜单管理
+
+![Screen Shot](https://github.com/basefas/files/blob/main/menu.png)
+
+### 角色及权限管理
+
+![Screen Shot](https://github.com/basefas/files/blob/main/permission.png)
+
+
+<!-- GETTING STARTED -->
+
+## 快速开始
+
+1. 克隆项目到本地
+
+```
+git clone https://github.com/basefas/admin-go
+```
+
+2. 安装依赖
+
+```
+go mod download
+```
+
+3. 运行
+
+```
+go run ./cmd/app/main.go
+```
+
+<!-- USE DOCKER -->
+
+## 使用 Docker 部署
+
+> 注：需要提前安装好 docker 和 docker-compose
+
+1. 切换目录
+
+```
+cd  ./deploy/docker-compose
+```
+
+2. 使用 docker-compose 一键部署
+
+```
+docker-compose up -d
+```
+
+3. 可以根据需要修改该文件夹下的配置文件及镜像版本
+
+<!-- LICENSE -->
+
+## 版权声明
+
+admin-go 基于 MIT 协议， 详情请参考 [license](LICENSE)。

deploy/docker-compose/config/config.js

@@ -3,7 +3,7 @@ version: '3'
 services:
 
   mysql:
-    image: mysql/mysql-server:5.7
+    image: mysql/mysql-server:8.0
     environment:
       MYSQL_ROOT_PASSWORD: "root"
       MYSQL_USER: "root"
@@ -19,7 +19,7 @@ services:
       - "13306:3306"
 
   admin-go:
-    image: ghcr.io/basefas/admin-go:v0.0.3
+    image: ghcr.io/basefas/admin-go:v0.1.0
     volumes:
       - ./config/app-config.yaml:/usr/src/app/config/app-config.yaml
     depends_on:
@@ -31,9 +31,7 @@ services:
       - "8086:8086"
 
   react-antd-admin:
-    image: ghcr.io/basefas/react-antd-admin:v0.0.3
-    volumes:
-      - ./config/config.js:/usr/share/nginx/html/config/config.js
+    image: ghcr.io/basefas/react-antd-admin:v0.1.0
     depends_on:
       - admin-go
     restart: always

deploy/docker-compose/docker-compose.yaml

@@ -1,12 +1,12 @@
-FROM golang:1.17 as builder
+FROM golang:1.19-alpine as builder
 ENV CGO_ENABLED 0
-WORKDIR /usr/src/app/
+WORKDIR /app
 COPY go.mod go.sum ./
 RUN go mod download
 COPY ./ ./
-RUN GOOS=linux GOARCH=amd64 go build -o ./bin/admin-go cmd/app/main.go
+RUN go build -o ./bin/app cmd/app/main.go
 
-FROM alpine:3.14
-WORKDIR /usr/src/app/
-COPY --from=builder /usr/src/app/bin/admin-go ./
+FROM alpine
+WORKDIR /app
+COPY --from=builder /app/bin/app ./
 ENTRYPOINT ["./app"]

deploy/docker/Dockerfile

@@ -1,16 +1,16 @@
-FROM golang:1.17 as builder
+FROM golang:1.19 as builder
 ENV CGO_ENABLED 0
 ENV GOPROXY https://goproxy.cn
-WORKDIR /usr/src/app/
+WORKDIR /app
 COPY go.mod go.sum ./
 RUN go mod download
 COPY ./ ./
-RUN GOOS=linux GOARCH=amd64 go build -o ./bin/admin-go cmd/app/main.go
+RUN go build -o ./bin/admin-go cmd/app/main.go
 
-FROM alpine:3.14
-WORKDIR /usr/src/app/
+FROM alpine
+WORKDIR /app
 RUN apk --no-cache add ca-certificates tzdata && \
     ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && \
     echo 'Asia/Shanghai' >/etc/timezone
-COPY --from=builder /usr/src/app/bin/admin-go ./
+COPY --from=builder /app/bin/admin-go ./
 ENTRYPOINT ["./admin-go"]

deploy/docker/chn.Dockerfile

@@ -1,6 +1,6 @@
 module admin-go
 
-go 1.17
+go 1.19
 
 require (
 	github.com/casbin/casbin/v2 v2.41.1