Skip to content

快速开始 ​

模板文档默认以脚手架生成的业务项目为上下文。后台应用直接位于项目根目录,公共组件由已发布的 @kevairy/components 包提供。

环境要求 ​

  • Node.js 22 或更高版本;
  • pnpm 10 或更高版本。

创建项目 ​

尚未生成业务项目时,先在 Kevairy 源仓库根目录执行:

bash
pnpm create:app my-admin

完整创建方式和 npm、yarn 支持见脚手架文档。

启动应用 ​

进入生成项目的根目录:

bash
cd my-admin
pnpm install # 脚手架已经安装依赖则跳过
pnpm dev

根命令会直接启动当前后台应用。

开发环境默认使用本地 Mock 认证:

text
账号:admin
密码:123456

找到应用入口 ​

text
my-admin/
├── src/config/       # 系统信息、导航与功能开关
├── src/adapters/     # 认证和导航适配边界
├── src/router/       # 路由模块与守卫
├── src/views/        # 页面
├── tests/unit/       # 单元测试
└── tests/e2e/        # 浏览器端到端测试

模板源代码中的路径在文档中统一相对于生成项目根目录描述。

下一步 ​

  1. 在全局配置中修改项目名称、品牌资源和功能开关;
  2. 按认证接入替换 Mock 适配器;
  3. 按路由与菜单添加项目页面;
  4. 使用搜索表格页面模式建立标准列表页;
  5. 运行项目测试中的质量命令。

如果你的目标是维护 Kevairy 源仓库或文档站,而不是开发生成项目,请查看维护者资料。