README.En.md

Simple Admin UI

English | 中文

Introduction

Simple Admin UI is a modern UI for Simple Admin. It is based on vue-vben-admin and supports several advanced features. It can help you developing a distributed backend management system in a short time.

Document Click here

Online Preview

Free Edition Online Preview

• Account admin
• Password simple-admin

Multi-tenant Edition Online Preview

• Administrator Tenant Account

  • Enterprise: admin
  • Account: admin
  • Password: simple-admin

• Tenant Account

  • Enterprise: 测试企业
  • Account: admin
  • Password: simple-admin

Read-only, cannot be modified or registered

Feature

• Latest technology stack: Developed based on the latest technologies such as Vue3/vite5
• TypeScript: Uses Typescript language
• Theme: Configurable themes
• Internationalization: Built-in complete internationalization solution
• Mock data Built-in Mock data testing solution
• Permission Supports dynamic routing permissions
• Component Secondary encapsulation of multiple commonly used components
• Remeda: Use remeda as a data processing tool

Support 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

More

Documentation

Simple Admin Documentation

• ant-design-vue Document

Preparation

• node and git - Project development environment
• Vite - Familiar with vite features
• Vue3 - Familiar with Vue basic syntax
• TypeScript - Familiar with the basic syntax of TypeScript
• Es6+ - Familiar with es6 basic syntax
• Vue-Router-Next - Familiar with the basic use of vue-router
• Ant-Design-Vue - ui basic use
• Mock.js - mockjs basic syntax

Quick Start

Quick Start Document

Change Log

CHANGELOG

Project

• Simple-Admin-ui
• Simple-Admin

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

Related warehouse

If these plugins are helpful to you, you can give a star support

• vite-plugin-mock - Used for local and development environment data mock
• vite-plugin-html - Used for html template conversion and compression
• vite-plugin-style-import - Used for component library style introduction on demand
• vite-plugin-theme - Used for online switching of theme colors and other color-related configurations
• vite-plugin-imagemin - Used to pack compressed image resources
• vite-plugin-compression - Used to pack input .gz|.brotil files
• vite-plugin-svg-icons - Used to quickly generate svg sprite

Browser support

The Chrome 80+ browser is recommended for local development

Support modern browsers, not IE

IE	Edge	Firefox	Chrome	Safari
not support	last 2 versions	last 2 versions	last 2 versions	last 2 versions

Maintainer

@Ryan Su

License

MIT © Ryan-2022