Skip to content

Commit

Permalink
Dev 1.3.0 update docs (#65)
Browse files Browse the repository at this point in the history
<!--
First of all, thank you for your contribution! 😄

For requesting to pull a new feature or bugfix, please send it from a
feature/bugfix branch based on the `master` branch.

Before submitting your pull request, please make sure the checklist
below is confirmed.

Your pull requests will be merged after one of the collaborators
approve.

Thank you!

-->

### 🤔 This is a ...

- [ ] New feature
- [ ] Bug fix
- [x] Site / documentation update
- [ ] Demo update
- [ ] Component style update
- [ ] TypeScript definition update
- [ ] Bundle size optimization
- [ ] Performance optimization
- [ ] Enhancement feature
- [ ] Internationalization
- [ ] Refactoring
- [ ] Code style optimization
- [ ] Test Case
- [ ] Branch merge
- [ ] Other (about what?)

### 🔗 Related issue link

<!--
1. Put the related issue or discussion links here.
-->

### 💡 Background and solution

<!--
1. Describe the problem and the scenario.
2. GIF or snapshot should be provided if includes UI/interactive
modification.
3. How to fix the problem, and list the final API implementation and
usage sample if that is a new feature.
-->

### 📝 Changelog

<!--
Describe changes from the user side, and list all potential break
changes or other risks.
--->

| Language   | Changelog |
| ---------- | --------- |
| 🇺🇸 English |           |
| 🇨🇳 Chinese |           |

### ☑️ Self-Check before Merge

⚠️ Please check all items below before review. ⚠️

- [x] Doc is updated/provided or not needed
- [ ] Demo is updated/provided or not needed
- [ ] TypeScript's definition is updated/provided or not needed
- [ ] Changelog is provided or not needed
  • Loading branch information
xxl4 authored Nov 17, 2023
2 parents 5610b5b + d0f68ba commit 2070f96
Show file tree
Hide file tree
Showing 5 changed files with 96 additions and 16 deletions.
13 changes: 13 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# Easy Admin Change log
> All notable changes to this project will be documented in this file.
## [v1.3.0](https://github.com/nicelizhi/easy-admin/releases/tag/1.3.0)
. fix the lang support
. add gzip support and gzip config
. add acro vue support function

## [v1.2.0](https://github.com/nicelizhi/easy-admin/releases/tag/1.2.0)
. change the db deleted_at to flag.
. fix the cores bug
. fix the cores security
. fix the easy-admin ui
. add MSSQL db sql
. fix the build docker to docker hub

## [v1.1.0](https://github.com/nicelizhi/easy-admin/releases/tag/1.1.0)
. fix the redis queue client bug

Expand Down
9 changes: 9 additions & 0 deletions docs/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ settings:
timezone: "Africa/Cairo"
# local
local: "en"
# gzip enable
gzip: true
#gzip level
# options 1、BestCompression 1、BestSpeed 1、DefaultCompression 1、NoCompression
# NoCompression = 0
# BestSpeed = 1
# BestCompression = 9
# DefaultCompression = -1
gziplevel: 9
ssl:
# https domain
domain: localhost:8000
Expand Down
9 changes: 9 additions & 0 deletions docs/guide/configure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ settings:
timezone: "Africa/Cairo"
# local
local: "en"
# gzip enable
gzip: true
#gzip level
# options 1、BestCompression 1、BestSpeed 1、DefaultCompression 1、NoCompression
# NoCompression = 0
# BestSpeed = 1
# BestCompression = 9
# DefaultCompression = -1
gziplevel: 9
ssl:
# https domain
domain: localhost:8000
Expand Down
39 changes: 25 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,32 @@

# easy-admin
# 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)
[![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)
[![Docker Pulls](https://img.shields.io/docker/pulls/nicesteven/easy-admin)](https://hub.docker.com/r/nicesteven/easy-admin)


## About Easy-Admin

Easyadmin is a Quick, beautiful and modern admin generator for Go VUE application.

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
## Online demo
- [Vue2 demo](https://easy-admin-ui.vercel.app)
- [Arco demo](https://hello-arco-pro.vercel.app/)( testing now)

## ✨ Feature

- Follow RESTful API design specifications
## Feature

- Based on the GIN WEB API framework, it provides rich middleware support (user authentication, cross-domain, access log, tracking ID, etc.)
- Based on the GIN WEB API framework, it provides rich middleware support (user authentication, cross-domain, access log, tracking ID, Cahce, Zip etc.)

- RBAC access control model based on Casbin

Expand All @@ -35,10 +44,12 @@

- Multi Language

- Multi-platform (Darwin Freebsd Linux Windows)

- TimeZone Support


## 🎁 Internal
## Internal

1. User management: The user is the system operator, this function mainly completes the system user configuration.
2. Department management: configure the system organization (company, department, group), and display the tree structure to support data permissions.
Expand Down Expand Up @@ -67,18 +78,18 @@ swag init --parseDependency --parseDepth=6 --instanceName admin -o ./docs/admin
http://localhost:8000/swagger/admin/index.html
```

# Install
# How to 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
# How to Configure

[Configure Docs](https://nicelizhi.github.io/easy-admin/guide/configure/)

Expand All @@ -90,4 +101,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)
[https://github.com/nicelizhi/easy-admin/discussions](https://github.com/nicelizhi/easy-admin/discussions)
42 changes: 40 additions & 2 deletions docs/zh/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,13 @@

- 多租户的支持

- 多语言支持
- 多语言支持 (已支持中文,英文)

- 时区功能支持

- TODO: 单元测试
- 静态打包,从而简化部署实施流程

- Gzip 的压缩支持,从而可以让您的应用跑的更快


## 🎁 内置
Expand All @@ -63,3 +65,39 @@
1. 内容管理:demo功能,下设分类管理、内容管理。可以参考使用方便快速入门。
1. 定时任务:自动化任务,目前支持接口调用和函数调用。

# Api 文档生成

```
swag init --parseDependency --parseDepth=6 --instanceName admin -o ./docs/admin
```

# 在线文档查看

```
http://localhost:8000/swagger/admin/index.html
```

# 如何安装部署

- [Docker 安装部署](https://nicelizhi.github.io/easy-admin/guide/install/docker)

- [Docker Composer 部署安装](https://nicelizhi.github.io/easy-admin/guide/install/docker-composer)

- [K8s 部署安装](https://nicelizhi.github.io/easy-admin/guide/install/k8s)

- [二进制部署安装](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
[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)

0 comments on commit 2070f96

Please sign in to comment.