HzyAdmin开源项目使用教程

1. 项目的目录结构及介绍

HzyAdmin 是一个前后端分离的权限管理系统基架，项目目录结构如下：

hzy-admin
├── admin-client-blazor    # 前端Blazor客户端目录
├── admin-client           # 前端Vue客户端目录
├── admin-generate-ef-seed-data  # 数据库种子数据生成目录
├── admin-server           # 后端服务目录
├── doc                    # 文档目录，包含数据库脚本和教程
├── gitee                  # 存放图片等资源
├── .gitignore             # Git忽略文件
├── LICENSE                # 开源协议文件
├── README.en.md           # 英文项目说明文件
├── README.md              # 中文项目说明文件

• admin-client-blazor: 前端使用Blazor框架开发的客户端项目。
• admin-client: 前端使用Vue3.x框架开发的客户端项目。
• admin-generate-ef-seed-data: 用于生成EF Core数据库种子数据的目录。
• admin-server: 后端服务，包括API接口和业务逻辑。
• doc: 包含项目文档、数据库脚本和使用教程。
• .gitignore: 指定Git应该忽略的文件和目录。
• LICENSE: 开源协议，本项目采用MIT协议。
• README.en.md 和 README.md: 项目说明文件，分别提供英文和中文说明。

2. 项目的启动文件介绍

后端启动文件

后端项目（admin-server）通常包含一个启动类，例如 Program.cs 或 Startup.cs，用于配置服务和启动Kestrel服务器。

// Program.cs 示例
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

前端启动文件

前端项目（admin-client 或 admin-client-blazor）的启动文件通常是一个入口文件，例如 main.js 或 Startup.cs。

// main.js 示例
import { createApp } from 'vue'
import App from './App.vue'
import router from './router'
import store from './store'

createApp(App).use(router).use(store).mount('#app')

3. 项目的配置文件介绍

项目的配置文件通常包括但不限于以下几种：

• appsettings.json: .NET Core项目的配置文件，用于存储应用程序的配置信息，如数据库连接字符串、API密钥等。

{
  "ConnectionStrings": {
    "DefaultConnection": "Your Connection String Here"
  }
}

• .env: Vue项目中的环境变量文件，用于存储不同环境下的配置信息，如API地址、端口等。

VUE_APP_API_URL=https://api.example.com
VUE_APP_API_PORT=8080

• launchSettings.json: Visual Studio使用的配置文件，用于指定应用程序的启动参数，如环境、启动URL等。

{
  "profiles": {
    "http": {
      "commandName": "Project",
      "dotnetRunMessages": true,
      "launchBrowser": true,
      "applicationUrl": "http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

请根据实际项目需求调整配置文件。