README.En.md

Simple Admin

English | 中文

Introduction

Simple Admin is a powerful microservice framework for large management systems. It is based on Go Zero and supports several advanced features. It provides a complete set of functionalities for user management, permission management, role management, menu management, log management, and configuration management. Additionally, it offers features like multilingual support. Simple Admin is suitable for both small and large enterprises to quickly build distributed backend management systems.

Here are some key points about Simple Admin:

• Development and Deployment Tools: Simple Admin comes with robust development and deployment tools. It is well-suited for high-concurrency, highly reliable, and complex business scenarios. The project supports easy one-click upgrades and provides comprehensive documentation, videos, and examples to help developers get started quickly.

• Free Basic Modules: The official release includes six free basic modules, covering 80% of common business requirements.

• Module Store: Simple Admin also offers a module store, where you can conveniently purchase and use additional modules to enhance your system.

The 6 free modules are all free for commercial use and are suitable for developer learning, internal use of enterprises, personal project use, etc. Everyone is welcome to use and feedback problems, and we will continue to update and maintain them.

Official Tutorial

Simple Admin

Goctls

Based on the enhanced version of go zero, it provides a lot of optimizations for simple admin, has a lot of additional code generation functions, fully supports ent, and easily realizes three-terminal code generation, making development easier.

Doge

Doge is Simple Admin's command line tool for module download and deployment. It provides module source code download, module docker, k8s deployment, server maintenance and other functions. Users can upload their own paid modules to earn revenue, and now 10+ modules are included.

Module Store

Feature

• State of The Art Development：Use latest back-end technology development such as ent, go-zero, casbin
• Fully support go-swagger: Write comment in api file and generate swagger doc easily
• Error handling: Handle error messages via one module
• International：Support different languages show in the front-end via put locale path in the message
• Service Discover: Use k8s endpoints to do service discovery and load-balance
• Authority Manage authority via Casbin, based on RBAC
• Code Generation: Built-in three-terminal Web, API, RPC code generation
• Multiple extensions: Provides a variety of extensions and has a very simple access function
• Other Builtin concurrency control, adaptive circuit breaker, adaptive load shedding, auto-trigger, auto recover
• ORM: Powerful Ent supported

Supported functions

• User management: manage system user data
• Department management: manage the department to which you belong
• Post management: configure the positions held by system users
• Menu management: configure system menus, tree display
• Role management: manage role permissions, support multiple roles
• Dictionary management: maintain data dictionary, convenient for front-end use
• Interface document: automatically generate related api interface documents according to business code
• Code generation: automatically generate CRUD code, quickly generate custom logic
• Token management: manage token status, support blacklisting token

Permanently Free Official Modules

Module Name	Module Introduction	Module Address
Core	Core Module	Core
Backend UI	Backend Interface	Backend UI
FMS	File Management	File
Job	Scheduled Task	Job
MMS	Member Management	Member
MCMS	Message Center	Message Center

Member Exclusive Modules

Module Name	Module Introduction
CMS	Content Management Module
Simple-Uni	Mini Program Development Scaffold
Simple-Nuxt	PC Web End Development Scaffold

Community Modules

Click to view

Project Planning Progress

RoadMap

Preview

Online preview

Online Preview Account: admin Password: simple-admin

Read Only, cannot register and modify

Documentation

Simple Admin Document

• go-zero Document
• ant-design-vue Document

Preparation

• Golang and git - Project development environment
• Ent - Ent
• Mysql - Familiar with mysql database
• GORM - Familiar with GORM apis
• Casbin - Familiar with Casbin apis
• Go-swagger - Go-swagger document generation

How to contribute

You are very welcome to join！Raise an issue Or submit a Pull Request。

Pull Request:

1. Fork code!
2. Create your own branch: git checkout -b feat/xxxx
3. Submit your changes: git commit -am 'feat(function): add xxxxx'
4. Push your branch: git push origin feat/xxxx
5. submitpull request

Git Contribution submission specification

• reference vue specification (Angular)

  • feat Add new features
  • fix Fix the problem/BUG
  • style The code style is related and does not affect the running result
  • perf Optimization/performance improvement
  • refactor Refactor
  • revert Undo edit
  • test Test related
  • docs Documentation/notes
  • chore Dependency update/scaffolding configuration modification etc.
  • workflow Workflow improvements
  • ci Continuous integration
  • types Type definition file changes
  • wip In development

Change Log

CHANGELOG

Community

Discard

Discussion

Stars

Maintainer

@Ryan Su

License

MIT © Ryan-2022