跳转到内容

快速开始

本篇带你在本地把 XiHan.BasicApp 的后端与前端跑起来。跟着做,约 10 分钟即可登录系统。

环境要求

依赖版本说明
.NET SDK10.0+后端运行时
Node.js20.0+前端构建
pnpm9.0+前端包管理器
PostgreSQL14+数据库(也支持 MySQL / MariaDB)
Redis6.0+分布式缓存与分布式锁

需要先准备好一个可连接的 PostgreSQL 和 Redis 实例。数据库表结构无需手动创建——首次启动会自动建表并初始化种子数据。

一、克隆代码

bash
git clone https://github.com/XiHanFun/XiHan.BasicApp.git
cd XiHan.BasicApp

二、配置数据库连接

编辑 backend/src/main/XiHan.BasicApp.WebHost/appsettings.Development.json,填入你的连接串:

json
{
  "XiHan": {
    "Data": {
      "SqlSugarCore": {
        "ConnectionConfigs": [
          {
            "DbType": "PostgreSQL",
            "ConnectionString": "Host=localhost;Port=5432;Database=xihan_basic_app;Username=postgres;Password=your_password;"
          }
        ]
      }
    }
  }
}

同时确认 Redis 连接配置正确(用于缓存与分布式锁)。具体配置节以仓库内 appsettings.Development.json 为准。

三、启动后端

bash
cd backend
dotnet run --project src/main/XiHan.BasicApp.WebHost --launch-profile Development

启动后:

首次启动会自动建表并执行数据种子初始化,稍等片刻即可。

四、启动前端

另开一个终端:

bash
cd frontend
pnpm install
pnpm dev

按终端提示的地址打开浏览器即可访问前端。

五、登录

初始超级管理员账号:

字段
账号superadmin
密码SuperAdmin@123

可通过配置 Saas:Seed:SuperAdminPassword(环境变量 Saas__Seed__SuperAdminPassword)覆盖初始密码。

安全提醒

生产环境务必覆盖初始密码,并在首次登录后立即修改。

常见问题

  • 启动报连不上数据库/Redis:先确认两者已启动、连接串正确、防火墙放通端口。
  • 表没建 / 登录不了:首次启动会自动建表与种子,若中途失败,排查数据库权限后重启。BasicApp 的部署策略是重建数据库、前向单一格式,不做旧数据兼容,遇异常态 fail-closed。
  • 端口被占用:Development 默认 9708,可在 launch profile 或配置中调整。

下一步

Released under The MIT License.