开物 Kaiwu

开物成务，构建可靠应用。

开物是基于 Laravel 12、Inertia.js 和 Vue 3 的通用应用开发脚手架。当前默认界面采用 Admin One，提供认证、账户设置、双因素认证、响应式应用布局、深色模式、示例页面、质量工具和项目文档结构。

它不局限于后台管理系统。新项目可以替换布局和页面形态，同时复用 Laravel 应用基线、认证、安全、工程质量和交付规范。

• PHP 8.2+ / Laravel 12
• Inertia.js 2 / Vue 3 / Pinia
• Tailwind CSS 4 / Admin One
• Laravel Fortify / Wayfinder
• Vite 7
• PHPUnit / Pint / ESLint / Vue TSC / Prettier

• 登录、注册、退出。
• 密码找回与重置。
• 邮箱验证。
• 用户资料与密码修改。
• TOTP 双因素认证与恢复码。
• 响应式后台布局和深色模式。
• 类型化前端路由。
• 示例 Dashboard 与常用后台组件。
• SQLite 本地开发配置。
• 初始化脚本与本地用户创建命令。
• 产品、技术、部署和质量文档模板。

脚手架不默认包含角色权限、多租户、审计日志和具体 CRM 业务模型。

• PHP 8.2+
• Composer 2
• Node.js 20.19+ 或 22.12+
• npm 10+

bash scripts/init-project.sh "My Admin Project"

初始化并创建本地用户：

bash scripts/init-project.sh \
  "My Admin Project" \
  admin@example.com \
  'ChangeMe123!' \
  "Administrator"

为了避免密码进入 shell 历史，推荐初始化后交互创建用户：

php artisan scaffold:user

composer run dev

默认访问地址：

http://127.0.0.1:8000

composer install
cp .env.example .env
touch database/database.sqlite
php artisan key:generate
php artisan migrate
npm install
npm run build

# 创建或更新本地用户
php artisan scaffold:user
php artisan scaffold:user \
  --name="Administrator" \
  --email=admin@example.com \
  --password='ChangeMe123!' \
  --force

# 数据库
php artisan migrate
php artisan migrate:fresh --seed

# 开发
php artisan serve
npm run dev

# 构建
npm run build

composer run quality

也可以独立执行：

vendor/bin/pint --test
php artisan test
npm run lint:check
npm run types:check
npm run format:check
npm run build

1. 修改 .env 中的应用名称、URL、数据库和邮件配置。
2. 替换 public 下的图标。
3. 替换 resources/js/pages/Dashboard.vue 示例内容。
4. 修改 resources/js/menuAside.js 和 menuNavBar.js。
5. 根据需求决定是否开放注册和邮箱验证。
6. 设计角色权限、审计日志和数据隔离。
7. 删除不需要的示例组件和依赖。
8. 更新 docs/01-product 中的产品文档。
9. 为重要技术选择新增 ADR。
10. 配置 CI、生产数据库、队列、邮件、备份和监控。

app/                    Laravel 应用代码
config/                 应用配置
database/               迁移、Factory、Seeder
docs/                   产品、技术、模板和 ADR
resources/js/           Vue、Inertia、Pinia
resources/css/          Tailwind 和 Admin One 样式
routes/                 Web 与 Console 路由
scripts/                项目初始化脚本
tests/                  自动化测试

完整说明见 文档中心。

• 禁止提交 .env、真实密码、API Key 和生产数据库。
• 生产环境必须设置 APP_DEBUG=false。
• .env.example 中的脚手架用户变量应保持为空。
• 本脚手架没有内置 RBAC，“已登录”不等于“有业务权限”。
• 上线前配置真实邮件、队列、缓存、备份和监控。

本项目以 MIT License 发布。后台 UI 包含 Admin One 的衍生代码，第三方声明见 THIRD_PARTY_NOTICES.md。