快速入门
星火赋能平台快速入门:本地部署、登录管理后台并跑通第一个业务模块
初版内容
本文正在按正式版本补充截图与参数,界面名称与数值以实际软件为准。
要点速览
星火赋能平台本地跑起来只需两个进程:后端 API(本地联调默认端口 5005)和 Vue 3 管理后台(默认端口 8888)。后端首次启动会自动建库并写入种子数据;项目同时面向 net8.0 与 net10.0,启动时必须用 -f 指定目标框架,且工作目录要留在项目目录。
这篇面向第一次拿到星火赋能平台(代码代号 Sepe.Net)源码的实施工程师和后端/前端开发人员。读完后你可以在本机把后端 API 与管理后台跑起来、用初始管理员账号登录,并用代码生成器做出第一个可用的业务模块。前置条件:已获取平台源码与交付清单(含初始账号),本机可以安装 .NET SDK 与 Node.js。
第 1 步:准备运行环境 #
目的:确认本机具备编译后端和构建前端所需的工具。
- 安装 .NET SDK:平台后端同时面向 net8.0 与 net10.0 两个目标框架,至少安装其中一个对应版本的 SDK(本文以 net8.0 为例)。
- 安装 Node.js 与 pnpm:管理后台前端(
Web/目录)基于 Vue 3 + Element Plus + Vite,依赖安装与构建都使用 pnpm。 - 准备数据库:平台通过 SqlSugar 支持 MySQL、PostgreSQL、SQL Server、SQLite 以及国产数据库。本地体验可以直接用 SQLite,不需要额外安装数据库服务。
- 可选组件:Redis 缓存、Elasticsearch 日志按项目需要启用,入门阶段可以先不配。
预期结果:在命令行执行 dotnet --list-sdks 能看到 8.x(或 10.x)SDK,执行 pnpm -v 能看到版本号。
第 2 步:了解工程目录并配置数据库 #
目的:知道各进程在哪里、数据库连接写在哪里,避免后面连错库。
| 目录 | 内容 | 本地联调端口 |
|---|---|---|
Sepe.Net/(解决方案 Sepe.Net.sln) | 后端,启动项目为 Sepe.Net.Web.Entry | 5005 |
Web/ | 管理后台前端(Vue 3) | 8888 |
App/ | 移动端(uni-app) | — |
- 打开后端的数据库配置文件
App.json,在ConnectionStrings中设置数据库类型与连接串。 - 本地体验保留默认的 SQLite 即可,默认连接串是相对路径
DataSource=./Sepe.Net.db。 - 使用 MySQL / PostgreSQL / SQL Server 等数据库时,先建好空库与账号,再把连接串改为对应数据库;表结构和种子数据由平台首次启动时自动生成。
注意:SQLite 连接串是相对于进程工作目录的。从哪个目录启动进程,就会使用(或新建)哪个目录下的库文件。
第 3 步:启动后端 API #
目的:让后端完成建库、写入种子数据,并对外提供接口。
- 命令行进入
Sepe.Net/Sepe.Net.Web.Entry项目目录(工作目录必须留在这里)。 - 设置环境变量:
ASPNETCORE_ENVIRONMENT=Development(读取开发环境配置),ASPNETCORE_URLS=http://localhost:5005。 - 执行启动命令,必须带目标框架参数:
dotnet run -f net8.0- 编译过一次之后,也可以在项目目录下直接运行编译产物(如
bin/Debug/net8.0/下的Sepe.Net.Web.Entry),启动更快;但工作目录仍要是项目目录,不要先进入bin目录再运行。
预期结果:访问 http://localhost:5005/api/sysConfig/smPublicKey,返回内容中 code 为 200,说明后端已正常运行。此时库文件与种子数据已经生成。
第 4 步:启动管理后台前端 #
目的:在浏览器里打开员工使用的管理后台。
- 命令行进入
Web/目录。 - 首次运行先安装依赖,再启动开发服务:
pnpm install
pnpm run dev- 前端开发配置
Web/.env.development中的VITE_API_URL指向后端地址(本地为http://localhost:5005),Vite 会把/api请求代理到后端,因此本地不需要处理跨域。
预期结果:浏览器打开 http://localhost:8888 能看到登录页。生产环境用 pnpm run build 打包成静态文件后由 Web 服务器托管。
第 5 步:登录并修改初始密码 #
目的:用种子数据中的管理员账号进入系统,并消除默认密码风险。
- 使用交付清单中提供的初始超级管理员账号登录。超级管理员不受接口权限限制,适合做初始化配置;另有系统管理员与普通员工测试账号可用于验证权限差异。
- 登录后立即在个人中心修改密码。用户表的种子数据只补不覆盖,改过的密码不会在下次启动时被还原。
- 如需查看接口,后端自带交互式接口文档:
http://localhost:5005/sapi/(Scalar)与http://localhost:5005/kapi/index.html(Knife4j 皮肤)。
预期结果:进入主控面板,左侧可以看到用户、机构、职位、菜单、角色、字典、日志、服务监控等内置菜单。
第 6 步:用代码生成器跑通第一个业务模块 #
目的:体验平台“建表 → 生成前后端代码与菜单 → 刷新即用”的开发方式。
- 在数据库中建一张业务表(例如一张简单的“设备台账”表),或按平台约定先编写实体类。
- 在管理后台的代码生成功能中选择这张表,为每个字段配置前端展示控件(输入框、下拉字典、日期等)和查询条件。
- 选择生成目标:建议生成到你自己新建的应用层工程,而不是平台自带的示例应用层。
- 执行生成,平台会输出后端服务与前端页面代码,并写入对应的菜单与按钮权限。
- 重新编译并启动后端,刷新管理后台。
预期结果:左侧出现新菜单,列表、查询、新增、编辑、删除可以直接使用。再到角色管理里给其它角色分配这个菜单,就能控制谁能看到它。
下一步 #
- 代码生成的参数含义与二次开发约定:代码生成器使用指南
- 配置组织、角色、按钮与数据权限,以及多租户:权限与多租户配置指南
- 启动失败、端口占用、数据“消失”等问题:本地部署与联调故障排查
- 部署环境、数据库、许可协议等常见疑问:星火赋能平台常见问题
- 获取部署手册与源码:星火赋能平台资料下载
