Merge pull request #25 from nicelizhi/dev

many update

.github/workflows/build.yml

@@ -5,6 +5,7 @@ on:
     branches: [ main ]
     paths-ignore:
       - .github/**
+      - docs/**
   pull_request:
     branches: [ main ]
 

README.md

@@ -1 +1,89 @@
-# 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/nicelizhi/easy-admin
+)](https://github.com/nicelizhi/easy-admin)
+
+
+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
+
+- Follow RESTful API design specifications
+
+- Based on the GIN WEB API framework, it provides rich middleware support (user authentication, cross-domain, access log, tracking ID, etc.)
+
+- RBAC access control model based on Casbin
+
+- JWT authentication
+
+- Support Swagger documents (based on swaggo)
+
+- Database storage based on GORM, which can expand multiple types of databases
+
+- Simple model mapping of configuration files to quickly get the desired configuration
+
+- Code generation tool
+
+- Multi-command mode
+
+- Multi Language
+
+- TimeZone Support
+
+- TODO: unit test
+
+
+## 🎁 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.
+3. Position management: configure the positions of system users.
+4. Menu management: configure the system menu, operation authority, button authority identification, interface authority, etc.
+5. Role management: Role menu permission assignment and role setting are divided into data scope permissions by organization.
+6. Dictionary management: Maintain some relatively fixed data frequently used in the system.
+7. Parameter management: dynamically configure common parameters for the system.
+8. Operation log: system normal operation log record and query; system abnormal information log record and query.
+9. Login log: The system login log record query contains login exceptions.
+1. Interface documentation: Automatically generate related api interface documents according to the business code.
+1. Code generation: According to the data table structure, generate the corresponding addition, deletion, modification, and check corresponding business, and the whole process of visual operation, so that the basic business can be implemented with zero code.
+1. Form construction: Customize the page style, drag and drop to realize the page layout.
+1. Service monitoring: View the basic information of some servers.
+1. Content management: demo function, including classification management and content management. You can refer to the easy to use quick start.
+
+# Api Document Generate
+
+```
+swag init --parseDependency --parseDepth=6 --instanceName admin -o ./docs/admin
+```
+
+# Online wagger Document
+
+```
+http://localhost:8000/swagger/admin/index.html
+```
+
+# Install
+
+[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
+
+[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) 
+
+# Discussions
+[https://github.com/nicelizhi/easy-admin/discussions](https://github.com/nicelizhi/easy-admin/discussions) 

docs/guide/install/docker-composer.md

@@ -15,7 +15,7 @@ version: '3.8'
 services:
   easy-admin:
     container_name: easy-admin
-    image: registry.ap-southeast-1.aliyuncs.com/kuops/easy-admin:latest
+    image: registry.ap-southeast-1.aliyuncs.com/kuops/easy-admin:1.0.0
     privileged: true
     restart: always
     ports:
@@ -52,7 +52,7 @@ version: '3.8'
 services:
   easy-admin:
     container_name: easy-admin
-    image: registry.ap-southeast-1.aliyuncs.com/kuops/easy-admin:latest
+    image: registry.ap-southeast-1.aliyuncs.com/kuops/easy-admin:1.0.0
     privileged: true
     restart: always
     ports:
@@ -73,10 +73,10 @@ services:
     restart: always
     environment:
       - POSTGRES_USER=root
-      - POSTGRES_PASSWORD=GoAdmin
-      - APP_DB_USER=GoAdmin
-      - APP_DB_PASS=GoAdmin
-      - APP_DB_NAME=GoAdmin
+      - POSTGRES_PASSWORD=easyadmin
+      - APP_DB_USER=easyadmin
+      - APP_DB_PASS=easyadmin
+      - APP_DB_NAME=easyadmin
     volumes:
       - ./db:/docker-entrypoint-initdb.d/
     expod:
@@ -93,13 +93,14 @@ networks:
 
 > You need have setting.yml file in ./config dir
 ```
-docker run --name api-admin -p 8000:8000 -v ./config:/easy-admin/config/ -d registry.ap-southeast-1.aliyuncs.com/kuops/easy-admin:latest
+docker-compose up -d // start
+docker-compose down // down
 ```
 
 ### 4、Test it
 
 ```
-docker exec -it api-admin bash 
+docker exec -it easy-admin bash 
 netstat -an | grep 8000
 ```
 

docs/guide/install/docker.md

@@ -6,7 +6,7 @@
 > tip: [how to install docker](https://nicelizhi.github.io/easy-admin/guide/install/installdocker)
 
 ```
-docker pull registry.ap-southeast-1.aliyuncs.com/kuops/easy-admin:latest 
+docker pull registry.ap-southeast-1.aliyuncs.com/kuops/easy-admin:1.0.0 
 ```
 > view docker images
 ```
@@ -21,16 +21,19 @@ docker images
 
 > You need have setting.yml file in ./config dir
 ```
-docker run --name api-admin -p 8000:8000 -v ./config:/easy-admin/config/ -d registry.ap-southeast-1.aliyuncs.com/kuops/easy-admin:latest
+docker run --name easy-admin -p 8000:8000 -v ./config:/config/ -d registry.ap-southeast-1.aliyuncs.com/kuops/easy-admin:1.0.0
 ```
 
 ### 4、Test it
 
 ```
-docker exec -it api-admin bash 
+docker exec -it easy-admin bash 
 netstat -an | grep 8000
 ```
 
+### 5、FAQ
+
+
 ### Issue Submit
 https://github.com/nicelizhi/easy-admin/issues
 

docs/index.md

@@ -2,9 +2,9 @@
 # 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)
+[![License](https://img.shields.io/github/license/nicelizhi/easy-admin
+)](https://github.com/nicelizhi/easy-admin)
 
-English | [简体中文](https://github.com/nicelizhi/easy-admin/blob/main/README.Zh-cn.md)
 
 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.
 
@@ -58,7 +58,7 @@ The front-end and back-end separation authority management system based on Gin +
 swag init --parseDependency --parseDepth=6 --instanceName admin -o ./docs/admin
 ```
 
-# Online swag Document
+# Online wagger Document
 
 ```
 http://localhost:8000/swagger/admin/index.html