# Shadcn Admin Template 一个基于现代技术栈的全栈管理后台启动模板,采用 Monorepo 架构,包含前端 React 应用和后端 Hono API 服务。 ## 🚀 特性 - **Monorepo 架构**: 使用 npm workspaces 管理多包项目 - **现代化技术栈**: React 19 + TypeScript + Hono + Tailwind CSS - **类型安全**: 完整的 TypeScript 严格模式配置 - **代码质量**: ESLint + Prettier + Husky 代码规范保障 - **开发体验**: 热重载、类型检查、代码格式化 - **生产就绪**: Docker 容器化部署配置 ## 📦 项目结构 ``` shadcn-admin-template/ ├── packages/ │ ├── client/ # 前端管理后台 (React + shadcn/ui) │ ├── server/ # 后端API服务 (Hono + TypeORM) │ └── shared/ # 共享代码和类型定义 ├── docs/ # 项目文档 ├── .vscode/ # 编辑器配置 ├── docker/ # Docker 配置 └── scripts/ # 部署脚本 ``` ## 🛠️ 开发环境要求 - Node.js >= 18.0.0 - npm >= 8.0.0 - Git ## ⚡ 快速开始 ### 安装依赖 ```bash npm install ``` ### 开发模式 启动前后端开发服务器: ```bash npm run dev ``` 前端应用将在 http://localhost:3000 运行 后端API将在 http://localhost:3001 运行 ### 构建生产版本 ```bash npm run build ``` ### 代码检查 ```bash # 代码格式检查 npm run lint # 类型检查 npm run typecheck # 运行测试 npm run test ``` ## 📋 可用脚本 - `npm run dev` - 启动开发环境(前后端) - `npm run build` - 构建生产版本 - `npm run test` - 运行测试 - `npm run lint` - 代码检查 - `npm run typecheck` - TypeScript 类型检查 ## 🔧 开发配置 ### Git Hooks 项目配置了 pre-commit hook,自动运行: - ESLint 代码检查 - Prettier 代码格式化 ### 编辑器配置 推荐使用 VS Code 并安装推荐扩展: - ESLint - Prettier - TypeScript Hero - Tailwind CSS IntelliSense ## 📚 文档 - [架构设计](./docs/architecture.md) - 详细的技术架构说明 - [产品需求文档](./docs/prd.md) - 产品功能和需求说明 - [用户故事](./docs/stories/) - 敏捷开发用户故事 ## 🐳 Docker 开发环境 项目包含完整的 Docker 开发环境配置: ```bash # 启动开发环境 docker-compose -f docker-compose.dev.yml up ``` ## 📄 许可证 MIT License