Skip to content

Commit 9501805

Browse files
committed
docs: 更新前端技术栈文档和页面布局规范
更新 README.md 和 AGENTS.md 文档,详细说明前端技术栈从 Flowbite 迁移到 DaisyUI v5 的变更 新增页面布局规范,包括元数据定义、DaisyUI 组件使用指南和主题适配说明
1 parent 7c85b5e commit 9501805

2 files changed

Lines changed: 23 additions & 10 deletions

File tree

AGENTS.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ DjangoStarter 是下一代 Django 项目快速开发模板,专为提升开发
2424
- 模板引擎: Django Templates
2525
- 交互框架: HTMX
2626
- JavaScript框架: Alpine.js
27-
- CSS框架: TailwindCSS
28-
- 组件库: Flowbite
27+
- CSS框架: TailwindCSS v4
28+
- 组件库: DaisyUI v5 (Pure CSS)
2929
- 图标: Font Awesome Free 6
3030
- 动画: AOS (Animate On Scroll)
3131

@@ -245,7 +245,9 @@ def list_users(request):
245245

246246
### Django View
247247

248-
- 在 context 中传入 title 和 breadcrumbs,示例代码:
248+
- **页面元数据**: 每个返回独立页面的视图函数(View)必须在 context 中定义 `title``breadcrumbs`,以保证统一的页面标题显示和导航体验。
249+
250+
示例代码:
249251

250252
```python
251253
context = {
@@ -267,6 +269,7 @@ def list_users(request):
267269
- 在各个 app 下创建 templates 目录编写前端页面代码,不要直接修改 src\templates 里的代码
268270
- DjangoStarter 提供 page_header 组件用于渲染标准页面标题和面包屑导航,位于 `django_starter/contrib/navbar/templatetags/page_tags.py` 内,使用时在模板代码顶部引入: `{% load page_tags %}`
269271
- 根据具体情况选择合适的交互方式,DjangoStarter 默认已集成 HTMX / Alpine.js 相关依赖和配置
272+
- **页面布局**: 默认使用 DaisyUI Drawer 布局,主内容区在 `block content` 中。
270273

271274
示例页面代码:
272275

@@ -284,6 +287,15 @@ def list_users(request):
284287
{% block content %}
285288
{% page_header title breadcrumbs %}
286289
<!-- 页面主体内容,外部已有 container 容器,这里直接写页面内容元素 -->
290+
<div class="card bg-base-100 shadow-xl">
291+
<div class="card-body">
292+
<h2 class="card-title">Card Title</h2>
293+
<p>Content goes here...</p>
294+
<div class="card-actions justify-end">
295+
<button class="btn btn-primary">Action</button>
296+
</div>
297+
</div>
298+
</div>
287299
{% endblock %}
288300

289301
<!-- Alpine.js 交互脚本 -->
@@ -300,11 +312,12 @@ def list_users(request):
300312

301313
#### CSS/TailwindCSS规范
302314

303-
- 优先使用 flowbite 组件库已有组件,保持界面设计风格统一
304-
- 使用 TailwindCSS 工具类
305-
- 避免直接使用 CSS
306-
- 使用响应式设计原则
307-
- 遵循移动优先的设计理念
315+
- **优先使用 DaisyUI 组件类** (如 `btn btn-primary`, `card`, `input input-bordered`),减少冗长的 Utility Classes。
316+
- 使用daisyui MCP查询组件列表和组件的类名。
317+
- 使用 TailwindCSS 工具类处理布局和微调。
318+
- 避免直接使用 CSS,利用 DaisyUI 的 Design Tokens (如 `bg-base-100`, `text-primary`) 确保 Light/Dark 主题适配。
319+
- 使用响应式设计原则。
320+
- 遵循移动优先的设计理念。
308321

309322
### 测试规范
310323

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
- **代码自动生成**:v3 版本进一步优化了代码生成器,丢掉了 DRF 这个包袱,只需要定义模型,就可以生成 schema 以及 RESTFul API,还能根据定义自动创建测试用例,大大提高开发效率。
5858
- **随机种子数据生成**:v3 版本内置 seed 模块,支持为已有模型自动填充假数据,方便开发测试。
5959
- **模块化项目结构**:推出了更加模块化的项目结构设计,方便开发者根据需要添加或移除功能模块,使项目维护更为简单。
60-
- **现代化前端集成**提供了对现代化前端技术的集成,以及利用 NPM 和 gulp 管理前端资源,帮助开发者打造富交互式的用户界面。
60+
- **现代化前端集成**采用 **TailwindCSS v4 + DaisyUI v5** 构建 UI,移除 Flowbite,支持 Light/Dark 多主题切换。使用 **Alpine.js** 处理前端交互,结合 HTMX 实现 SPA 级体验。以及利用 NPM 和 gulp 管理前端资源,帮助开发者打造富交互式的用户界面。
6161
- **容器化支持**:内置 Dockerfile 和 docker-compose.yml 配置,简化了容器化部署的过程,支持一键部署到任何支持 Docker 的环境。
6262
- **详尽的文档与社区支持**:提供全面的文档和指南,覆盖从项目启动到部署的每一个步骤。同时,基于活跃的 Django 开源社区,开发者可以轻松获取支持和反馈。
6363

@@ -99,7 +99,7 @@ v2版本已经定下了大体的框架,v3的主要改动是将 RestFramework
9999
- 随机种子数据,目前使用 faker 实现假数据,打算进一步实现类似 EFCore 的种子数据机制,使假数据更自然
100100
- 新的登录接口
101101
- 多种第三方登录接入(目前接了微信、小程序、企微)
102-
- 使用 tailwindcss 替换 bootstrap 实现前端(只是一些简单的后台展示,还是以 API 为主)
102+
- 使用 TailwindCSS v4 + DaisyUI 重构前端,提供精美的现代化 UI 组件与布局,支持多主题切换
103103
- 拆分 settings 配置,像 AspNetCore 那样支持多个环境配置
104104
- 更换了包管理器为 uv
105105

0 commit comments

Comments
 (0)