Introduction

Introduction

Simple Admin is an out-of-the-box distributed microservice back-end management system developed based on go-zero, which provides rich functions for the development of medium and large back-ends, supports three-terminal code generation. The official comes with a variety of extensions to help small and medium-sized enterprises quickly go to the cloud and iterate quickly. Suitable for microservice learning and commercial use, open source and free.

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.

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

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

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

Quick Start

Quick Start Document

Relative Project

• Simple Admin
• Simple Admin Backend UI

Optional Components

• File Management
• Scheduled Task
• Member Management

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

Community

Discard

Discussion

Stars

Star History Chart

Maintainer

@Ryan Su

License

MIT © Ryan-2022