1. Project Overview

Easy Vben

Developed based on open-source frameworks such as SpringBoot2, Druid, Mybatis Plus, Apache Shiro, Activiti, Beetl, HuTool, and Quartz. Includes built-in modules for permissions, departments, parameters, dictionaries, scheduled tasks, and code generation.

Easy-Vben is an admin backend solution based on SpringBoot2, Druid, Mybatis Plus, Shiro, and other technologies. Its goal is to provide an out-of-the-box solution for developing medium and large-scale projects. The project uses a modern frontend technology stack and can serve as a project starter template to help you quickly build enterprise-level backend product prototypes. It can also serve as a practical example for learning mainstream technologies such as SpringBoot, Mybatis, and Shiro. The project continuously tracks the latest technologies and incorporates them into the codebase.

2. Open Source License

Licensed under MIT

3. Screenshots

4. Feature Overview

Developed based on open-source frameworks such as SpringBoot2, Druid, Mybatis Plus, Apache Shiro, Activiti, Beetl, HuTool, and Quartz. Includes built-in modules for permissions, departments, parameters, dictionaries, scheduled tasks, and code generation.

Recommended for use with the Easy-Vben-Admin frontend open-source project.

Features

Latest Technology Stack

Developed using the latest technology stack, including SpringBoot2, Vue3, Vite, and TypeScript

️Rich Examples

Examples of commonly used web plugins

Component Encapsulation

Provides enhanced wrappers for frequently used components to meet basic development needs

Agile Development

Provides visual code generation and encapsulates commonly used frontend and backend methods

Theme Configuration

Rich theme configuration options and dark mode support

Permission Management

Comprehensive Permission Management Solution

5. Tech Stack

Backend

• SpringBoot2
• Druid
• Mybatis
• Shiro
• Activiti
• HuTool
• Quartz
• Beetl

Environment Preparation

Your local environment needs to have the following installed

• JDK1.8^
• MySQL8.0^
• Redis
• Git

Directory Structure

├── db                   # SQL scripts
│   ├── activiti         # Workflow
│   ├── easy-vben.sql   # Basic SQL
│   ├── easy-cms.sql     # CMS SQL
│   └── quartz.sql       # Scheduled tasks
├── easy-activiti        # Workflow
├── easy-api             # Entry point
├── easy-cms             # CMS
├── easy-common          # Utilities
│   ├── easy-core        # Core
│   ├── easy-mybatis     # MyBatis
│   └── easy-redis       # Redis
├── easy-file            # File management
├── easy-generator       # Code generation
├── easy-sample          # Examples
├── easy-scheduler       # Scheduled tasks
└── easy-sys             # System

Frontend

• Vue3 Documentation
• Vue-RFCS
• Migrating from Vue2 to Vue3
• TypeScript
• Vue-router
• Ant-Design-Vue
• Es6
• Vitejs
• WindiCss

Environment Preparation

The local environment requires Yarn1.x, Node.js, and Git

note:

Yarn1.x must be used; otherwise, dependencies may fail to install.

Node.js version 12.x or above is required, but version 13.x is not supported. Version 14.x or above is recommended.

Directory explanation

.
├── build # Build scripts
│   ├── config # Configuration files
│   ├── generate # Generators
│   ├── script # Scripts
│   └── vite # Vite configuration
├── mock # Mock files
├── public # Public static assets directory
├── src # Main directory
│   ├── api # API files
│   ├── assets # Assets
│   │   ├── icons # Icon sprite directory
│   │   ├── images # Project image directory
│   │   └── svg # Project SVG image directory
│   ├── components # Shared components
│   ├── design # Style files
│   ├── directives # Directives
│   ├── enums # Enums/Constants
│   ├── hooks # Hooks
│   │   ├── component # Component-related hooks
│   │   ├── core # Core hooks
│   │   ├── event # Event-related hooks
│   │   ├── setting # Configuration-related hooks
│   │   └── web # Web-related hooks
│   ├── layouts # Layout files
│   │   ├── default # Default layout
│   │   ├── iframe # Iframe layout
│   │   └── page # Page layout
│   ├── locales # Localization
│   ├── logics # Logic
│   ├── main.ts # Main entry point
│   ├── router # Routing configuration
│   ├── settings # Project settings
│   │   ├── componentSetting.ts # Component configuration
│   │   ├── designSetting.ts # Style configuration
│   │   ├── encryptionSetting.ts # Encryption configuration
│   │   ├── localeSetting.ts # Localization configuration
│   │   ├── projectSetting.ts # Project configuration
│   │   └── siteSetting.ts # Site configuration
│   ├── store # Data store
│   ├── utils # Utilities
│   └── views # Pages
├── test # Tests
│   └── server # Services used for testing
│       ├── api # Test API server
│       ├── upload # Test upload server
│       └── websocket # Test WebSocket server
├── types # Type definitions
├── vite.config.ts # Vite configuration file
└── windi.config.ts # Windi CSS configuration file