建立 docs/user/ 和 docs/development/ 分层文档结构: - docs/README.md 文档总路由、归属矩阵、影响分析规则 - docs/user/ 模板使用、配置、部署、故障排查 - docs/development/ 架构、后端、前端、构建发布开发规范 - README.md 轻量化为项目入口和索引 - 删除 DEVELOPMENT.md,内容拆分至专题文档 - 更新 openspec/config.yaml 首读入口和文档影响分析规则 - 修正 docs/prompts/README.md 过时引用和边界说明
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
# my-app
|
|
|
|
(替换为你的项目介绍)
|
|
|
|
Bun 全栈应用模板,基于 Bun + React + TDesign 的前后端一体化开发框架。
|
|
|
|
## 快速开始
|
|
|
|
```bash
|
|
git clone <your-repo-url> my-project
|
|
cd my-project
|
|
cp config.example.yaml config.yaml
|
|
bun install
|
|
bun run dev config.yaml
|
|
```
|
|
|
|
访问 http://127.0.0.1:5173 查看应用。
|
|
|
|
## 使用此模板
|
|
|
|
从零创建新项目:[使用模板](docs/user/usage.md)
|
|
|
|
## 文档导航
|
|
|
|
| 文档 | 内容 |
|
|
| -------------------------------------- | ---------------------------------- |
|
|
| [docs/README.md](docs/README.md) | 文档总览、归属矩阵、影响分析规则 |
|
|
| [docs/user/](docs/user/) | 模板使用、配置、部署、故障排查 |
|
|
| [docs/development/](docs/development/) | 架构、后端、前端、构建发布开发规范 |
|
|
| [docs/prompts/](docs/prompts/) | AI 提示词资产(不属于常规文档流) |
|
|
|
|
## 常用命令
|
|
|
|
| 命令 | 说明 |
|
|
| ---------------------- | ------------ |
|
|
| `bun run dev <config>` | 启动开发模式 |
|
|
| `bun run build` | 生产构建 |
|
|
| `bun test` | 运行测试 |
|
|
| `bun run check` | 完整质量检查 |
|
|
| `bun run verify` | 验证构建流程 |
|
|
|
|
## 开源协议
|
|
|
|
MIT
|