README.En.md

December 4, 2023 · View on GitHub

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

Feature

  • State of The Art Development:Use latest front-end technology development such as Vue3/vite2
  • TypeScript: Application-level JavaScript language
  • Theming: Configurable themes
  • International:Built-in complete internationalization program
  • Mock Server Built-in mock data scheme
  • Authority Built-in complete dynamic routing permission generation scheme.
  • Component Multiple commonly used components are encapsulated twice

Support functions

  • User management: The user is the system operator, and this function mainly completes the system user configuration.
  • Department management: Configure the system organization (company, department, group), and the tree structure shows the support data permissions.
  • Position management: configure the positions that system users belong to.
  • Menu management: configure system menu, operation authority, button authority identification, interface authority, etc.
  • Role management: role menu permission assignment, role setting, data range permission division by organization.
  • Dictionary management: maintain some relatively fixed data frequently used in the system.
  • Operation log: system normal operation log record and query; system abnormal information log record and query.
  • Member management: manage registered member information
  • Interface documents: Automatically generate relevant API interface documents based on business codes.
  • Code generation: Generate corresponding additions, deletions, modifications, and queries based on the data table structure
  • Service monitoring: View some basic information about servers

Project Planning Progress

RoadMap

Online preview

Online Preview Account: admin Password: simple-admin

Read Only, cannot register and modify

pic pic

More

Documentation

Simple Admin Documentation

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

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

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

Browser support

The Chrome 80+ browser is recommended for local development

Support modern browsers, not IE

 Edge
IE
 Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
not supportlast 2 versionslast 2 versionslast 2 versionslast 2 versions

Maintainer

@Ryan Su

License

MIT © Ryan-2022