Skip to content

README.En.md

Latest commit

 

History

History
174 lines (128 loc) · 5.61 KB

README.En.md

File metadata and controls

174 lines (128 loc) · 5.61 KB

Simple Admin

English | 中文

Go-Zero Vben Admin GORM Casbin Release License: MIT SimpleAdmin

Introduction

Simple Admin is a powerful microservice framework for basic management. It is based on go-zero and supports several advanced features. It can help you to develop a microservice back-end management core in a short time.

Feature

  • State of The Art Development：Use latest back-end technology development such as gorm, 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
  • Other builtin concurrency control, adaptive circuit breaker, adaptive load shedding, auto-trigger, auto recover

Current Progress

Module Status
Login and Register Finished
Menu Management Finished
Role Management Finished
Role Authority Finished
User Management Finished
Operation log Finished
Service discovery Finished
Configuration center Finished
Dictionary management Finished
Oauth management Finished
Fully support K8s Finished
Service Monitor Finished
Log collecting Finished
JWT blacklist Finished
Job Schedule In progress

The use of consul for service registration discovery in the early stage of the project is mainly to adapt to low-configuration servers. In the near future, the deployment process of K8s will be mainly optimized, and the project will mainly use K8s for deployment in the future.

Preview

Online preview

Online Preview Account: admin Password: simple-admin

Read Only, cannot register and modify

pic pic pic

More

Documentation

Document

or running locally

cd docs
docsify serve .

Preparation

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

Install and use

  • Get the project code
git clone https://github.com/suyuan32/simple-admin-core.git
  • Installation dependencies
cd simple-admin-core/

go mod tidy

  • Edit api/etc/core.yaml rpc/etc/core.yaml

  • Run

# run core api
cd api 
go run core.go -f etc/core.yaml

# run core rpc
cd rpc
go run core.go -f etc/core.yaml
  • Build
go build -o core core.go

Change Log

CHANGELOG

Project

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

Maintainer

@Ryan Su

License

MIT © Ryan-2022