Skip to content

Latest commit

 

History

History
154 lines (124 loc) · 7.05 KB

README.md

File metadata and controls

154 lines (124 loc) · 7.05 KB

mss-boot-admin

Build Status Release License

English | 简体中文

Introduction

A front-end and back-end separation authority management system based on Gin, React, Ant Design v5, Umi v4, and mss-boot. Initialized with an environment variable, it supports multiple configuration sources, simplifies database setup, and eases service startup. Features include multi-tenancy, roles, users, menus, internationalization, system configuration, permissions, virtual models, notifications, and dictionaries.

Beta Environment

Swagger

Tutorial

Online documentation Video tutorial

Project address

Backend project Front-end project

🎬 Experience environment

Experience address

Account: admin Password: 123456

✨ Features

  • Support internationalization
  • Standard Restful API development specifications
  • RBAC permission management based on Casbin
  • Database storage based on Gorm
  • Middleware development based on Gin
  • Swagger document generation based on Gin
  • Support oauth2.0 third-party login
  • Support swagger document generation
  • Support multiple configuration sources (local files, embed, object storage s3, etc., databases supported by gorm, mongodb)
  • Support virtual model (dynamic configuration supports front-end and back-end functions)
  • Support database migration
  • Support microservice code generation

📦 Built-in functions

  • User management: Users are system operators, and this function mainly completes the configuration of system users.
  • Role management: Role menu permission allocation, set role data range permission division by organization.
  • Menu management: Configure system menus, operation permissions, button permission identifiers, etc.
  • Option management: dynamically configure enumerations.
  • Model management: Manage virtual models.
  • System configuration: Manage the configuration of various environments.
  • Notice announcement: user notification message.
  • Task management: Manage scheduled tasks, including execution logs.
  • Internationalization management: Manage internationalization resources.
  • Microservice code generation: Generate microservice code based on templates.

📦 Preparation

  • Install golang1.21+
  • Install mysql8.0+
  • Install nodejs18.16.0+

📦 Quick start

1. Download the project

# Download the backend project
git clone https://github.com/mss-boot-io/mss-boot-admin.git
# Download the front-end project
git clone https://github.com/mss-boot-io/mss-boot-admin-antd.git

2. Migrate the database

# Enter the backend project
cd mss-boot-admin
# Configure database connection information (can be modified according to actual situation)
export DB_DSN="root:123456@tcp(127.0.0.1:3306)/mss-boot-admin-local?charset=utf8mb4&parseTime=True&loc=Local"
# Migrate the database
go run main.go migrate

3. Generate API interface information

# Generate API interface information
go run main.go server -a

4. Start the backend service

# Start the backend service
go run main.go server

5. Start the front-end service

# Enter the front-end project
cd mss-boot-admin-antd
# Install dependencies
npm install
# Start the front-end service
npm run start

📨 Interaction

mss-boot-io
telegram🔥🔥🔥 WeChat WeChat MP🔥🔥🔥 mss-boot技术交流群 bilibili🔥🔥🔥

💎 Contributors

JetBrains open source certificate support

The mss-boot-io project has always been developed in the GoLand integrated development environment under JetBrains, based on the free JetBrains Open Source license(s) genuine free license. I would like to express my gratitude.

🤝 Special thanks

  1. ant-design
  2. ant-design-pro
  3. umi
  4. gin
  5. casbin
  6. gorm
  7. gin-swagger
  8. jwt-go
  9. oauth2

🤟 Sponsor Us

If you think this project helped you, you can buy a glass of juice for the author to show encouragement 🍹

Sponsor Us

🔑 License

MIT

Copyright (c) 2024 mss-boot-io