# easy-admin

**Repository Path**: jamesying/easy-admin

## Basic Information

- **Project Name**: easy-admin
- **Description**: No description available
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-17
- **Last Updated**: 2025-06-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Easy Admin 后台管理应用 README

## 一、项目概述

Easy Admin 后台管理应用是一个基于 .NET 6/8 (Furion/SqlSugar) 实现的通用权限开发框架，前端采用 Vue3+Arco+vite，数据库默认使用 SQLite，同时支持多数据库。该应用旨在为开发者提供一个高效、便捷的后台管理解决方案，具备完善的权限管理功能，可快速搭建各种类型的后台管理系统。

## 二、技术栈介绍

### 后端

- **.NET 6/8**：微软推出的跨平台开发框架，具有高性能、稳定性强等特点，为应用提供强大的运行支持。
- **Furion**：轻量级的 .NET 开发框架，集成了众多实用的功能和工具，如依赖注入、AOP 编程等，可提高开发效率。
- **SqlSugar**：一款高性能的 ORM 框架，支持多种数据库，简化了数据库操作，提供了丰富的 API 接口。

### 前端

- **Vue3**：渐进式 JavaScript 框架，采用了组合式 API，提高了代码的可维护性和复用性。
- **Arco**：字节跳动出品的企业级设计系统，提供了丰富的组件和样式，可快速搭建美观、易用的前端界面。
- **Vite**：新一代前端构建工具，具有快速冷启动、即时热更新等优点，提升了开发体验。

### 数据库

- **SQLite**：轻量级的嵌入式数据库，无需单独的服务器进程，适合小型项目和开发环境。它以其独特的单文件格式和无需服务端的特性，在众多环境中提供可靠的数据存储解决方案。SQLite 数据库完全自足、高度可靠、配置简单，且不需要依赖于复杂的设置或外部服务器。因此，SQLite 成为了那些需要简单、有效且独立运行的数据库系统的首选。
- **多数据库支持**：除了 SQLite，还支持 MySQL、PostgreSQL 等常见数据库，可根据项目需求进行灵活切换。

## 三、项目结构

### 后端结构

```plaintext
backend/
├── Easy Admin.Admin.Application # 应用服务层
├── Easy Admin.Admin.Core # 核心业务逻辑
├── Easy Admin.Admin.Entity # 实体模型
├── Easy Admin.Admin.Repository # 数据仓储
├── Easy Admin.Admin.WebApi # WebAPI 接口
│   ├── Controllers # 控制器
│   ├── Filters # 过滤器
│   ├── Middlewares # 中间件
│   └── Program.cs # 程序入口
│   ├── appsettings.json # 配置文件
│   └── appsettings.Development.json # 开发环境配置
├── Easy Admin.Admin.Tool # 工具类

```

### 前端结构

```plaintext
frontend/
├── public # 静态资源
├── src/
│   ├── api/ # API请求
│   ├── assets/ # 资源文件
│   ├── components/ # 组件
│   ├── router/ # 路由配置
│   ├── stores/ # 状态管理
│   ├── utils/ # 工具函数
│   ├── views/ # 页面视图
│   ├── App.vue # 应用入口组件
│   └── main.js # 应用入口JS
├── index.html # HTML模板
├── package.json # 依赖配置
└── vite.config.js # Vite配置
```

## 四、安装步骤

### 后端

1. **克隆项目**：

```bash
  git clone [项目仓库地址]
  cd [项目目录]
```

2. **安装依赖**：打开命令行工具，进入后端项目目录，运行以下命令安装所需的 NuGet 包：

```bash
  dotnet restore
```

3. **配置数据库**：在 `appsettings.json` 文件中配置数据库连接字符串，示例如下：

```json
  { 
    "ConnectionStrings": { 
      "DefaultConnection": "Data Source=./Database/YourDatabase.db;" 
    } 
  }
```

如果需要使用其他数据库，可根据相应的数据库类型修改连接字符串。

### 前端

1. **进入前端项目目录**：

```bash
  cd [前端项目目录]
```
2. **安装依赖**：运行以下命令安装前端依赖：
```bash
  npm install
```

## 五、运行项目
### 后端
在后端项目目录下，运行以下命令启动后端服务：
```bash
  dotnet run
```
### 前端
在前端项目目录下，运行以下命令启动前端开发服务器：
```bash
  npm run dev
```

打开浏览器，访问 `http://localhost:3000` 即可看到应用界面。

## 六、使用方法

### 权限管理

本应用提供了完善的权限管理功能，包括用户管理、角色管理、菜单管理等。

- **用户管理**：可对用户信息进行增删改查操作，分配用户角色。
- **角色管理**：定义不同的角色，为角色分配相应的菜单权限和操作权限。
- **菜单管理**：配置系统菜单，设置菜单的显示顺序、权限标识等。

### 数据库操作

通过 SqlSugar 框架进行数据库操作，示例代码如下：

```csharp
  using SqlSugar; 
  // 创建数据库连接 
  var db = new SqlSugarClient(new ConnectionConfig() { 
    ConnectionString = "Data Source=./Database/YourDatabase.db;", 
    DbType = DbType.Sqlite, 
    IsAutoCloseConnection = true 
  }); 
  // 查询数据 
  var list = db.Queryable<YourEntity>().ToList(); 
```

## 七、数据库配置

### SQLite 配置

在 `appsettings.json` 文件中配置 SQLite 数据库连接字符串：

```json
  { 
    "ConnectionStrings": { 
      "DefaultConnection": "Data Source=./Database/YourDatabase.db;" 
    } 
  }
```

### 其他数据库配置

如果需要使用其他数据库，如 MySQL，可按以下步骤进行配置：

1. **安装数据库驱动**：在后端项目中安装相应的数据库驱动 NuGet 包，如 `MySqlConnector`。
2. **修改连接字符串**：在 `appsettings.json` 文件中修改数据库连接字符串，示例如下：

```json
  { 
    "ConnectionStrings": { 
      "DefaultConnection": "Server=localhost;Database=YourDatabase;Uid=root;Pwd=yourpassword;" 
    } 
  }
```

## 八、贡献指南

### 代码规范

- 遵循 .NET 开发规范和 Vue 开发规范，保持代码的一致性和可读性。
- 编写清晰、简洁的注释，解释代码的功能和实现思路。

### 提交代码

- 提交代码前，请确保代码通过了单元测试和集成测试。
- 提交代码时，提供详细的提交信息，说明本次提交的内容和目的。

### 问题反馈

如果发现项目存在问题或有改进建议，请在项目仓库的 Issues 中提交详细的问题描述和复现步骤。

## 九、许可证

本项目采用 [许可证名称] 许可证，详情请参阅 `LICENSE` 文件。