# HzyAdmin

**Repository Path**: hzy6/HzyAdmin

## Basic Information

- **Project Name**: HzyAdmin
- **Description**: 通用管理平台！基于【.Net9、HZY.Framework】兼容【模块化、Winforms、Wpf】基础功能：【AOP、数据权限、按钮权限、动态菜单、动态任务调度、动态WebApi、定时标记 [Scheduled("0/5 * * * * ?")] 、代码生成】
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: http://47.98.179.56/docs
- **GVP Project**: No

## Statistics

- **Stars**: 1341
- **Forks**: 461
- **Created**: 2018-03-12
- **Last Updated**: 2026-04-22

## Categories & Tags

**Categories**: backend

**Tags**: Net10, Winforms, EF10, React, vue3

## README

# Please submit any issues here: [https://gitee.com/hzy6/HzyAdmin/issues/new](https://gitee.com/hzy6/HzyAdmin/issues/new)

> ⚠️ Cannot open .slnx file? Please use Rider or Visual Studio with .slnx preview feature enabled.

![Cover Image](gitee/images/image_cover.png)

# HzyAdmin - General Management Platform

A front-end and back-end separated permission management system based on .NET 10 + Vue 3, designed with modular architecture for rapid enterprise application development.

## Tech Stack

### Backend Technologies

| Technology | Description |
| --- | --- |
| .NET 10 | Base framework |
| Entity Framework Core 10 | ORM framework |
| HZY.Framework | Core framework (DI, Dynamic API, Repository, etc.) |
| Rougamo.Fody | AOP programming |
| Redis/FreeRedis | Distributed cache |
| Quartz.NET | Task scheduling |
| Mapster | Object mapping |
| MiniExcel | Excel processing |
| Swagger/Knife4j | API documentation UI |

### Frontend Technologies

| Technology | Description |
| --- | --- |
| Vue 3.5+ | Progressive JavaScript framework |
| Ant Design Vue 4.x | UI component library |
| Vite 7.x | Build tool |
| Pinia 3.x | State management |
| TypeScript 5.x | Type support |
| Vue Router 4.x | Routing management |
| VxeTable 4.x | Advanced table component |
| ECharts 6.x / @antv/g2 | Chart visualization |
| WangEditor 5.x | Rich text editor |
| vue-i18n 11.x | Internationalization support |

## Project Structure

```
HzyAdmin/
├── hzy-backend/                          # Backend project
│   ├── src/                              # Source code
│   │   ├── HZY.Host.Admin/               # Web API host project
│   │   ├── HZY.Repository.Admin/         # Data repository layer
│   │   ├── HZY.Shared.Admin/             # Shared module (DTOs, enums, etc.)
│   │   ├── HZY.Shared/                   # Base shared module
│   │   ├── HZY.Core/                     # Core module
│   │   ├── HZY.Core.EntityFramework/     # EF Core extensions
│   │   ├── HZY.Core.Identity/            # Authentication module
│   │   ├── HZY.Core.Redis/               # Redis cache module
│   │   ├── HZY.Core.FreeRedis/           # FreeRedis module
│   │   ├── HZY.Core.Quartz/              # Scheduled task module
│   │   ├── HZY.Core.MessageQueueCap/     # Message queue module
│   │   ├── HZY.Core.UploadFile/          # File upload module
│   │   ├── HZY.Core.Logs/                # Logging module
│   │   ├── HZY.Core.Swagger/             # Swagger docs
│   │   ├── HZY.Core.QrCode/              # QR code module
│   │   └── HZY.Core.Razor/               # Razor view module
│   ├── tests/                            # Test projects
│   ├── projects/                         # Project configuration
│   └── admin-generate-ef-seed-data/      # Seed data generation tool
│   └── hzy-frontend-admin/               # Frontend project
├── doc/                                  # Documentation and database scripts
└── gitee/                                # Image resources
```

## Feature Modules

### System Management

| Module | Description |
| --- | --- |
| User Management | User CRUD, role assignment, password reset |
| Role Management | Role configuration, menu permissions, function permissions |
| Menu Management | Menu configuration, button permissions, icon management |
| Organization | Department tree structure management |
| Post Management | Position information management |
| Dictionary Management | System dictionary data maintenance |
| API Management | System API interface management |
| File Management | System file upload management |
| Operation Log | User operation log recording and query |
| Data Permission | Row-level data permission control |
| Localization | Internationalization language configuration |
| Server Monitor | Server status monitoring |
| Personal Center | Personal info modification, password change |

### Development Tools

| Module | Description |
| --- | --- |
| Scheduled Tasks | Quartz task scheduling management |
| EF Core Monitor | EF Core runtime status monitoring |

## Quick Start

### Requirements

- .NET 10.0 SDK
- Node.js 18+
- Redis
- Rider or Visual Studio 2022
- VS Code (for frontend development)

### Backend Setup

```bash
cd hzy-backend

# Restore dependencies
dotnet restore

# Run the project
dotnet run --project src/HZY.Host.Admin
```

### Frontend Setup

```bash
cd hzy-backend/hzy-frontend-admin

# Install dependencies
npm install
# or
yarn install

# Start development server
npm run dev
# or
yarn dev

# Build for production
npm run build
```

### Database Configuration

Database scripts are located in the `doc/` directory:

- `hzy_admin_2026_pgsql.sql` - PostgreSQL script

For other databases (MySQL, SQL Server), use EF Core migrations:

```bash
cd hzy-backend/src/HZY.Host.Admin

# Add migration
dotnet ef migrations add InitialCreate

# Update database
dotnet ef database update
```

### Docker Deployment

The project provides a complete Docker Compose configuration for one-click deployment of all services.

**Service Components:**
- `hzy-admin` - API service (port 5500)
- `postgres` - PostgreSQL 16 database (port 5432)
- `redis` - Redis 7 cache (port 6379)

**Start Services:**

```bash
cd src/HZY.Host.Admin

# Start all services
docker-compose up -d

# View logs
docker-compose logs -f hzy-admin

# Stop services
docker-compose down
```

**Start Database and Cache Only (for local development):**

```bash
docker-compose up -d postgres redis
```

**Initialize Database:**

```bash
# Method 1: Use the provided SQL script
docker exec -i hzy-postgres psql -U root -d hzy_admin_2026 < ../../doc/hzy_admin_2026_pgsql.sql

# Method 2: Execute inside container
docker exec -it hzy-postgres psql -U root -d hzy_admin_2026 -f /docker-entrypoint-initdb.d/init.sql
```

**Configuration:**

You can override settings via environment variables:
- `AdminRepositoryOptions__ConnectionString` - Database connection string
- `AdminRepositoryOptions__DefaultDatabaseType` - Database type
- `ConnectionStrings__Redis` - Redis connection string

## Related Links

- 📖 **Documentation/Demo**: http://47.98.179.56/docs
- 🎬 **Bilibili Video**: https://www.bilibili.com/video/BV1tt4y157qH
- 🔗 **MVC Version**: https://gitee.com/hzy6/hzy-admin-mvc
- ⏰ **WebApi Task Scheduling Platform**: https://gitee.com/hzy6/hzy-quartz
- 📦 **NuGet Packages**: https://www.nuget.org/packages?q=hzy

## Screenshots

### Modular Project Structure
![Project Structure](gitee/images/project_map.jpg)

### Feature List
![Feature List](gitee/images/menu_map_2023-2-3.jpg)

### Microservice Case - Modular Project Structure
![Microservice Structure](gitee/images/project_1.jpg)

### Property Injection
![Property Injection](gitee/images/attr_inj.png)

### ✨ UI Screenshots

![WinForm](gitee/images/winform.png)

| ![Dark Theme](gitee/images/theme_dark.png) | ![Dark Theme 1](gitee/images/theme_dark_1.png) |
|---|---|

| ![Data Authority](gitee/images/DataAuthority.png) | ![Function](gitee/images/function.png) |
|---|---|

| ![Menu Info](gitee/images/MenuInfo.png) | ![Menu Function](gitee/images/menu_function.png) |
|---|---|

| ![Home](gitee/images/home.png) | ![Icons](gitee/images/icons.png) |
|---|---|

| ![Chart](gitee/images/chart.png) | ![More Charts](gitee/images/%E6%9B%B4%E5%A4%9A%E5%9B%BE%E8%A1%A8.png) |
|---|---|

| ![User List](gitee/images/user_list.png) | ![Wang Editor](gitee/images/wangeditor.png) |
|---|---|

| ![Code Generation](gitee/images/code_gen.png) | ![User Center](gitee/images/user_center.png) |
|---|---|

| ![Login](gitee/images/login.png) | ![EF Core Monitor](gitee/images/Efcore%20%E7%9B%91%E6%8E%A7.png) |
|---|---|

![Home 1](gitee/images/home1.png)

## Contributing

1. Fork this repository
2. Create a new Feat_xxx branch
3. Commit your code
4. Create a Pull Request

## License

This project is open-sourced under the [MIT](LICENSE) license.