From 634687f6fbdddd23d788d38bd8eab8d95821472c Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 9 Nov 2023 08:20:34 +0800 Subject: [PATCH 1/9] upgrade --- docs/index.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index c230a1c..a58db1c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,17 @@ # easy-admin + [![Build Status](https://github.com/nicelizhi/easy-admin/workflows/Build/badge.svg)](https://github.com/nicelizhi/easy-admin) [![Release](https://img.shields.io/github/release/nicelizhi/easy-admin.svg?style=flat-square)](https://github.com/nicelizhi/easy-admin/releases) [![Go Report Card](https://goreportcard.com/badge/github.com/nicelizhi/easy-admin)](https://goreportcard.com/report/github.com/nicelizhi/easy-admin) +[![HitCount](https://views.whatilearened.today/views/github/nicelizhi/easy-admin.svg)](https://github.com/nicelizhi/easy-admin) [![License](https://img.shields.io/github/license/nicelizhi/easy-admin )](https://github.com/nicelizhi/easy-admin) +[![Commits](https://img.shields.io/github/commit-activity/m/nicelizhi/easy-admin?color=ffff00)](https://github.com/nicelizhi/easy-admin/commits/main) + +## About Easy-Admin + +Easyadmin is a Quick, beautiful and modern admin gererator for Go VUE application. >> The front-end and back-end separation authority management system based on Gin + Vue is extremely simple to initialize the system. You only need to modify the database connection in the configuration file. The system supports multi-instruction operations. Migration instructions can make it easier to initialize database information. Service instructions It's easy to start the api service. @@ -31,6 +38,8 @@ - Multi Language +- Multi-platform (Darwin Freebsd Linux Windows) + - TimeZone Support @@ -65,13 +74,13 @@ http://localhost:8000/swagger/admin/index.html # Install -[Docker Install](https://nicelizhi.github.io/easy-admin/guide/install/docker) +- [Docker Install](https://nicelizhi.github.io/easy-admin/guide/install/docker) -[Docker Composer Install](https://nicelizhi.github.io/easy-admin/guide/install/docker-composer) +- [Docker Composer Install](https://nicelizhi.github.io/easy-admin/guide/install/docker-composer) -[K8s Install](https://nicelizhi.github.io/easy-admin/guide/install/k8s) +- [K8s Install](https://nicelizhi.github.io/easy-admin/guide/install/k8s) -[Binary Install](https://nicelizhi.github.io/easy-admin/guide/install/binary) +- [Binary Install](https://nicelizhi.github.io/easy-admin/guide/install/binary) # Configure From a10d72632663a005581b94416973c4b7bcd0d56c Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 9 Nov 2023 09:17:33 +0800 Subject: [PATCH 2/9] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E4=B8=AD=E6=96=87?= =?UTF-8?q?=E4=BB=8B=E7=BB=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/index.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/zh/index.md b/docs/zh/index.md index e938009..d1a844f 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -1,12 +1,15 @@ # easy-admin - - +[![Build Status](https://github.com/nicelizhi/easy-admin/workflows/Build/badge.svg)](https://github.com/nicelizhi/easy-admin) [![Release](https://img.shields.io/github/release/nicelizhi/easy-admin.svg?style=flat-square)](https://github.com/nicelizhi/easy-admin/releases) -[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/nicelizhi/easy-admin) +[![Go Report Card](https://goreportcard.com/badge/github.com/nicelizhi/easy-admin)](https://goreportcard.com/report/github.com/nicelizhi/easy-admin) +[![HitCount](https://views.whatilearened.today/views/github/nicelizhi/easy-admin.svg)](https://github.com/nicelizhi/easy-admin) +[![License](https://img.shields.io/github/license/nicelizhi/easy-admin +)](https://github.com/nicelizhi/easy-admin) +[![Commits](https://img.shields.io/github/commit-activity/m/nicelizhi/easy-admin?color=ffff00)](https://github.com/nicelizhi/easy-admin/commits/main) -[English](https://github.com/nicelizhi/easy-admin/blob/master/README.md) | 简体中文 +[English](https://nicelizhi.github.io/easy-admin/) | 简体中文 -基于Gin + Vue + Element UI OR Arco Design OR Ant Design的前后端分离权限管理系统,系统初始化极度简单，只需要配置文件中，修改数据库连接，系统支持多指令操作，迁移指令可以让初始化数据库信息变得更简单，服务指令可以很简单的启动api服务 +基于Gin + Arco Design的前后端分离权限管理系统,系统初始化极度简单.实现了Docker,docker-compose,二进制下载安装，K8S 部署方式。完美的实现了静态文件打包到GO中，很好的简化用户的使用体验。 ## ✨ 特性 @@ -37,7 +40,7 @@ - 时区功能支持 -- TODO: 单元测试 +- 多平台支持，多CPU架构支持。 ## 🎁 内置 @@ -52,10 +55,9 @@ 7. 参数管理：对系统动态配置常用参数。 8. 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。 9. 登录日志：系统登录日志记录查询包含登录异常。 -1. 接口文档：根据业务代码自动生成相关的api接口文档。 +1. 接口文档：根据业务代码自动生成相关的接口文档。 1. 代码生成：根据数据表结构生成对应的增删改查相对应业务，全程可视化操作，让基本业务可以零代码实现。 1. 表单构建：自定义页面样式，拖拉拽实现页面布局。 1. 服务监控：查看一些服务器的基本信息。 -1. 内容管理：demo功能，下设分类管理、内容管理。可以参考使用方便快速入门。 1. 定时任务：自动化任务，目前支持接口调用和函数调用。 From b1486e0ec0cf50a4a99db4c5080f076ae0d154dd Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 9 Nov 2023 09:18:39 +0800 Subject: [PATCH 3/9] upgrade --- docs/zh/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/index.md b/docs/zh/index.md index d1a844f..901d95c 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -36,7 +36,7 @@ - 多租户的支持 -- 多语言支持 +- 多语言支持，现支持 中文与英语，采用灵活的接口配置，方便添加更多语言的支持 - 时区功能支持 From 62806c98e53c85cd768b611a672809d135244999 Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 9 Nov 2023 09:20:34 +0800 Subject: [PATCH 4/9] upgrade --- docs/zh/index.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/zh/index.md b/docs/zh/index.md index 901d95c..a16ee77 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -61,3 +61,31 @@ 1. 服务监控：查看一些服务器的基本信息。 1. 定时任务：自动化任务，目前支持接口调用和函数调用。 +# 安装 + +- [Docker Install](https://nicelizhi.github.io/easy-admin/guide/install/docker) + +- [Docker Composer Install](https://nicelizhi.github.io/easy-admin/guide/install/docker-composer) + +- [K8s Install](https://nicelizhi.github.io/easy-admin/guide/install/k8s) + +- [Binary Install](https://nicelizhi.github.io/easy-admin/guide/install/binary) + + +# 配置 + +[Configure Docs](https://nicelizhi.github.io/easy-admin/guide/configure/) + +# 在线文档 +[https://nicelizhi.github.io/easy-admin/](https://nicelizhi.github.io/easy-admin/) + +# Issue +[https://github.com/nicelizhi/easy-admin/issues](https://github.com/nicelizhi/easy-admin/issues) +[https://gitee.com/nicelizhi/easy-admin/issues](https://gitee.com/nicelizhi/easy-admin/issues) (中国) + +# Discussions +[https://github.com/nicelizhi/easy-admin/discussions](https://github.com/nicelizhi/easy-admin/discussions) + + + + From 55b1385fc5b2e5f756a558e8bc9220e19c65fda2 Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 9 Nov 2023 09:22:59 +0800 Subject: [PATCH 5/9] upgrade --- docs/zh/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/index.md b/docs/zh/index.md index a16ee77..b6102e5 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -24,7 +24,7 @@ - 支持 Swagger 文档(基于swaggo) -- 基于 GORM 的数据库存储，可扩展多种类型数据库 +- 基于 GORM 的数据库存储，可扩展多种类型数据库, 现支持 MySQL, PostgreSQL, SQlite, SQL Server, Tidb - 配置文件简单的模型映射，快速能够得到想要的配置 From f46ac7214980421817b07758548ec7003c7276e6 Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 9 Nov 2023 09:24:15 +0800 Subject: [PATCH 6/9] upgrade --- docs/zh/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/zh/index.md b/docs/zh/index.md index b6102e5..350cdbf 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -14,9 +14,9 @@ ## ✨ 特性 -- 遵循 RESTful API 设计规范 +- 遵循 RESTful 接口 设计规范 -- 基于 GIN WEB API 框架，提供了丰富的中间件支持（用户认证、跨域、访问日志、追踪ID等） +- 基于 GIN 框架，提供了丰富的中间件支持（用户认证、跨域、访问日志、追踪ID，缓存，压缩等） - 基于Casbin的 RBAC 访问控制模型 From 96bb89c7d472452302a33525fd85c3604581b4c2 Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 9 Nov 2023 09:36:14 +0800 Subject: [PATCH 7/9] upgrade --- docs/index.md | 4 ++++ docs/zh/index.md | 5 ++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index a58db1c..31c8ee9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,11 +9,15 @@ )](https://github.com/nicelizhi/easy-admin) [![Commits](https://img.shields.io/github/commit-activity/m/nicelizhi/easy-admin?color=ffff00)](https://github.com/nicelizhi/easy-admin/commits/main) +English | [简体中文](https://nicelizhi.github.io/easy-admin/zh/) + ## About Easy-Admin Easyadmin is a Quick, beautiful and modern admin gererator for Go VUE application. + + >> The front-end and back-end separation authority management system based on Gin + Vue is extremely simple to initialize the system. You only need to modify the database connection in the configuration file. The system supports multi-instruction operations. Migration instructions can make it easier to initialize database information. Service instructions It's easy to start the api service. ## ✨ Feature diff --git a/docs/zh/index.md b/docs/zh/index.md index 350cdbf..cf35f6f 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -9,7 +9,10 @@ [English](https://nicelizhi.github.io/easy-admin/) | 简体中文 -基于Gin + Arco Design的前后端分离权限管理系统,系统初始化极度简单.实现了Docker,docker-compose,二进制下载安装，K8S 部署方式。完美的实现了静态文件打包到GO中，很好的简化用户的使用体验。 +## 关于 Easy Admin +> 由于自己在具体的业务场景中，经常是会需要管理后台的来维护对应的业务系统，从而就有了这么一个想法，通过提供基础的管理后台系统的方式，方便大家可以免费使用。 + +> 基于Gin + Arco Design的前后端分离权限管理系统,系统初始化极度简单.实现了Docker,docker-compose,二进制下载安装，K8S 部署方式。完美的实现了静态文件打包到GO中，很好的简化用户的使用体验。 ## ✨ 特性 From 79a44650a9459d8602a91e43dc1c775254d81945 Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 9 Nov 2023 09:56:16 +0800 Subject: [PATCH 8/9] =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/guide/configure/index.md | 6 ++- docs/guide/install/binary.md | 6 ++- docs/zh/guide/configure/index.md | 65 ++++++++++++++++++++++++++++++++ docs/zh/guide/install/binary.md | 31 +++++++++++++++ 4 files changed, 104 insertions(+), 4 deletions(-) create mode 100644 docs/zh/guide/configure/index.md create mode 100644 docs/zh/guide/install/binary.md diff --git a/docs/guide/configure/index.md b/docs/guide/configure/index.md index ef90fbd..86ba615 100644 --- a/docs/guide/configure/index.md +++ b/docs/guide/configure/index.md @@ -1,5 +1,7 @@ -# Go Admin Configure -> [View Online Config file](https://github.com/nicelizhi/easy-admin/blob/main/config/settings.full.yml) +# Easy Admin Configure +> [View Online Config file](https://github.com/nicelizhi/easy-admin/blob/main/config/settings.full.yml) + +English | [简体中文](https://nicelizhi.github.io/easy-admin/zh/guide/configure/) ``` settings: application: diff --git a/docs/guide/install/binary.md b/docs/guide/install/binary.md index d0b588e..56d27b9 100644 --- a/docs/guide/install/binary.md +++ b/docs/guide/install/binary.md @@ -1,6 +1,8 @@ # Binary Install easy-admin > Build a full-featured administrative interface quickly easy-admin +English | [简体中文]((https://nicelizhi.github.io/easy-admin/zh/guide/install/binary)) + ### 1、Ready > [https://github.com/nicelizhi/easy-admin/releases](https://github.com/nicelizhi/easy-admin/releases) download file for you @@ -9,7 +11,7 @@ [Configure Docs](https://nicelizhi.github.io/easy-admin/guide/configure/) -### 3、Start It (Ubuntu/Centos) +### 3、Start It (Linux) ``` chmod +x ./easy-admin @@ -17,7 +19,7 @@ chmod +x ./easy-admin ``` -### 4、Test it +### 4、Test it （Linux） ``` ps aux | grep "easy-admin" // diff --git a/docs/zh/guide/configure/index.md b/docs/zh/guide/configure/index.md new file mode 100644 index 0000000..5bb0305 --- /dev/null +++ b/docs/zh/guide/configure/index.md @@ -0,0 +1,65 @@ +# Easy Admin 配置 +> [查看最新在线配置文件](https://github.com/nicelizhi/easy-admin/blob/main/config/settings.full.yml) + +[English](https://nicelizhi.github.io/easy-admin/guide/configure/) | 简体中文 +``` +settings: + application: + # dev test prod + mode: dev + # host IP ，default 0.0.0.0 + host: 0.0.0.0 + # application name + name: easy-admin + # application port + port: 8000 + readtimeout: 1 + writertimeout: 2 + # enable dp + enabledp: false + # timezone + timezone: "Africa/Cairo" + # local + local: "en" + ssl: + # https domain + domain: localhost:8000 + # https enable + enable: false + # ssl key + key: keystring + # ssl pem path + pem: temp/pem.pem + logger: + # log save path + path: temp/logs + # file / default + stdout: '' + # trace, debug, info, warn, error, fatal + level: trace + # enable db log + enableddb: false + jwt: + # token secret + secret: easy-admin + # token timeout (S) + timeout: 3600 + database: + # mysql，sqlite3， postgres + driver: mysql + source: user:password@tcp(127.0.0.1:3306)/dbname?charset=utf8&parseTime=True&loc=Local&timeout=1000ms + # source: sqlite3.db + # source: host=myhost port=myport user=gorm dbname=gorm password=mypassword + registers: + - sources: + - user:password@tcp(127.0.0.1:3306)/dbname?charset=utf8&parseTime=True&loc=Local&timeout=1000ms + gen: + dbname: dbname + frontpath: ../ui/src + queue: + memory: + poolSize: 100 + extend: # ext config + demo: + name: data +``` \ No newline at end of file diff --git a/docs/zh/guide/install/binary.md b/docs/zh/guide/install/binary.md new file mode 100644 index 0000000..2d95905 --- /dev/null +++ b/docs/zh/guide/install/binary.md @@ -0,0 +1,31 @@ +# 二进制下载安装 +> 通过此方案，简单的通过下载对应平台的可执行文件，做下简单的文件配置就可以完成应用的开启使用 + +[English](https://nicelizhi.github.io/easy-admin/guide/install/binary) | 简体中文 + +### 1、准备 +> [Easy Admin 官方下载页面](https://github.com/nicelizhi/easy-admin/releases) 下载可执行文件 + + +### 2、配置 + +[配置文件](https://nicelizhi.github.io/easy-admin/zh/guide/configure/) + +### 3、开始运行 （Linux） + +``` +chmod +x ./easy-admin +./easy-admin server -c=config/settings.yml + +``` + +### 4、测试（Linux） + +``` +ps aux | grep "easy-admin" // +netstat -an | grep 8000 +``` + +### 提交BUG与建议 +https://github.com/nicelizhi/easy-admin/issues + From a2e4a547ea46310ef10c7abc55a4a3c843615346 Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 9 Nov 2023 10:04:38 +0800 Subject: [PATCH 9/9] upgrade --- docs/index.md | 6 ++---- docs/zh/index.md | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index 31c8ee9..35649b6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,5 @@ -# easy-admin +# # Easy Admin [![Build Status](https://github.com/nicelizhi/easy-admin/workflows/Build/badge.svg)](https://github.com/nicelizhi/easy-admin) [![Release](https://img.shields.io/github/release/nicelizhi/easy-admin.svg?style=flat-square)](https://github.com/nicelizhi/easy-admin/releases) @@ -13,9 +13,7 @@ English | [简体中文](https://nicelizhi.github.io/easy-admin/zh/) ## About Easy-Admin -Easyadmin is a Quick, beautiful and modern admin gererator for Go VUE application. - - +Easyadmin is a Quick, Easy, beautiful and modern admin gererator for Go VUE application. >> The front-end and back-end separation authority management system based on Gin + Vue is extremely simple to initialize the system. You only need to modify the database connection in the configuration file. The system supports multi-instruction operations. Migration instructions can make it easier to initialize database information. Service instructions It's easy to start the api service. diff --git a/docs/zh/index.md b/docs/zh/index.md index cf35f6f..aa5ec1e 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -1,4 +1,4 @@ -# easy-admin +# Easy Admin [![Build Status](https://github.com/nicelizhi/easy-admin/workflows/Build/badge.svg)](https://github.com/nicelizhi/easy-admin) [![Release](https://img.shields.io/github/release/nicelizhi/easy-admin.svg?style=flat-square)](https://github.com/nicelizhi/easy-admin/releases) [![Go Report Card](https://goreportcard.com/badge/github.com/nicelizhi/easy-admin)](https://goreportcard.com/report/github.com/nicelizhi/easy-admin)