diff --git a/docs/guide/configure/index.md b/docs/guide/configure/index.md index d83fffa..f834003 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/index.md b/docs/index.md index dbb1345..0a02676 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,5 @@ + # Easy-Admin [![Go Reference](https://godoc.org/github.com/nicelizhi/easy-admin?status.svg)](https://godoc.org/github.com/nicelizhi/easy-admin) [![Build Status](https://github.com/nicelizhi/easy-admin/workflows/Build/badge.svg)](https://github.com/nicelizhi/easy-admin) @@ -18,6 +19,7 @@ Easyadmin is a Quick, beautiful and modern admin generator for Go VUE applicatio English | [简体中文](https://nicelizhi.github.io/easy-admin/zh/) + >> 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. ## Online demo 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 + diff --git a/docs/zh/index.md b/docs/zh/index.md index b0f0f06..679735a 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -1,12 +1,18 @@ -# 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) -[![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://nicelizhi.github.io/easy-admin/) | 简体中文 -[English](https://github.com/nicelizhi/easy-admin/blob/master/README.md) | 简体中文 +## 关于 Easy Admin +> 由于自己在具体的业务场景中，经常是会需要管理后台的来维护对应的业务系统，从而就有了这么一个想法，通过提供基础的管理后台系统的方式，方便大家可以免费使用。 -基于Gin + Vue + Element UI OR Arco Design OR Ant Design的前后端分离权限管理系统,系统初始化极度简单，只需要配置文件中，修改数据库连接，系统支持多指令操作，迁移指令可以让初始化数据库信息变得更简单，服务指令可以很简单的启动api服务 +> 基于Gin + Arco Design的前后端分离权限管理系统,系统初始化极度简单.实现了Docker,docker-compose,二进制下载安装，K8S 部署方式。完美的实现了静态文件打包到GO中，很好的简化用户的使用体验。 ## 在线DEMO - [Vue2 demo](https://easy-admin-ui.vercel.app) @@ -15,9 +21,9 @@ ## ✨ 特性 -- 遵循 RESTful API 设计规范 +- 遵循 RESTful 接口 设计规范 -- 基于 GIN WEB API 框架，提供了丰富的中间件支持（用户认证、跨域、访问日志、追踪ID等） +- 基于 GIN 框架，提供了丰富的中间件支持（用户认证、跨域、访问日志、追踪ID，缓存，压缩等） - 基于Casbin的 RBAC 访问控制模型 @@ -25,7 +31,7 @@ - 支持 Swagger 文档(基于swaggo) -- 基于 GORM 的数据库存储，可扩展多种类型数据库 +- 基于 GORM 的数据库存储，可扩展多种类型数据库, 现支持 MySQL, PostgreSQL, SQlite, SQL Server, Tidb - 配置文件简单的模型映射，快速能够得到想要的配置 @@ -37,14 +43,16 @@ - 多租户的支持 -- 多语言支持 （已支持中文，英文） - - 时区功能支持 - 静态打包，从而简化部署实施流程 - Gzip 的压缩支持，从而可以让您的应用跑的更快 +- 多语言支持，现支持 中文与英语，采用灵活的接口配置，方便添加更多语言的支持 + +- 多平台支持，多CPU架构支持。 + ## 🎁 内置 @@ -58,11 +66,10 @@ 7. 参数管理：对系统动态配置常用参数。 8. 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。 9. 登录日志：系统登录日志记录查询包含登录异常。 -1. 接口文档：根据业务代码自动生成相关的api接口文档。 +1. 接口文档：根据业务代码自动生成相关的接口文档。 1. 代码生成：根据数据表结构生成对应的增删改查相对应业务，全程可视化操作，让基本业务可以零代码实现。 1. 表单构建：自定义页面样式，拖拉拽实现页面布局。 1. 服务监控：查看一些服务器的基本信息。 -1. 内容管理：demo功能，下设分类管理、内容管理。可以参考使用方便快速入门。 1. 定时任务：自动化任务，目前支持接口调用和函数调用。 # Api 文档生成 @@ -88,11 +95,11 @@ http://localhost:8000/swagger/admin/index.html - [二进制部署安装](https://nicelizhi.github.io/easy-admin/guide/install/binary) -# How to Configure +# 配置 [Configure Docs](https://nicelizhi.github.io/easy-admin/guide/configure/) -# Document +# 在线文档 [https://nicelizhi.github.io/easy-admin/](https://nicelizhi.github.io/easy-admin/) # Issue @@ -100,4 +107,4 @@ http://localhost:8000/swagger/admin/index.html [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) \ No newline at end of file +[https://github.com/nicelizhi/easy-admin/discussions](https://github.com/nicelizhi/easy-admin/discussions)