Compare commits
No commits in common. "main" and "feat/zhz" have entirely different histories.
16
.claude/settings.local.json
Normal file
16
.claude/settings.local.json
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
"permissions": {
|
||||||
|
"allow": [
|
||||||
|
"Bash",
|
||||||
|
"ReadFiles",
|
||||||
|
"WriteFiles",
|
||||||
|
"EditFiles",
|
||||||
|
"WebFetch(domain:3d.hunyuan.tencent.com)",
|
||||||
|
"WebSearch",
|
||||||
|
"WebFetch(domain:cloud.tencent.com)",
|
||||||
|
"WebFetch(domain:cloud.tencent.com.cn)",
|
||||||
|
"WebFetch(domain:ui-ux-pro-max-skill.nextlevelbuilder.io)",
|
||||||
|
"mcp__zai-mcp-server__analyze_image"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
109
.claude/skills/README.md
Normal file
109
.claude/skills/README.md
Normal file
@ -0,0 +1,109 @@
|
|||||||
|
# 页面生成规范索引
|
||||||
|
|
||||||
|
## 文档列表
|
||||||
|
|
||||||
|
| 文档 | 用途 | 路径 |
|
||||||
|
|------|------|------|
|
||||||
|
| 列表页规范 | 生成赛事列表页(Tab + 搜索 + 表格) | [contest-list-page.md](./contest-list-page.md) |
|
||||||
|
| 详情页规范 | 生成详情页(返回 + 标题 + 搜索 + 表格) | [contest-detail-page.md](./contest-detail-page.md) |
|
||||||
|
| 后端接口规范 | 生成 NestJS 接口(Controller + Service + DTO) | [backend-api.md](./backend-api.md) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 快速生成模板
|
||||||
|
|
||||||
|
### 一、列表页(如:赛果发布列表、报名管理列表)
|
||||||
|
|
||||||
|
```
|
||||||
|
请生成一个赛事列表页面:
|
||||||
|
|
||||||
|
页面名称:xxx
|
||||||
|
文件路径:xxx
|
||||||
|
|
||||||
|
搜索条件:
|
||||||
|
- 字段1(类型)
|
||||||
|
|
||||||
|
表格列:
|
||||||
|
- 序号
|
||||||
|
- 列名(数据字段)
|
||||||
|
- 操作(按钮列表)
|
||||||
|
|
||||||
|
详情跳转:路由路径
|
||||||
|
```
|
||||||
|
|
||||||
|
### 二、详情页(如:赛果详情、报名记录)
|
||||||
|
|
||||||
|
```
|
||||||
|
请生成一个详情页面:
|
||||||
|
|
||||||
|
页面名称:xxx
|
||||||
|
文件路径:xxx
|
||||||
|
|
||||||
|
标题:字段名
|
||||||
|
操作按钮:按钮名称 -> 处理函数
|
||||||
|
|
||||||
|
搜索条件:
|
||||||
|
- 字段1(类型)
|
||||||
|
|
||||||
|
表格列:
|
||||||
|
- 序号
|
||||||
|
- 列名(数据字段,渲染类型)
|
||||||
|
|
||||||
|
排序:字段名 + 排序方式
|
||||||
|
```
|
||||||
|
|
||||||
|
### 三、完整功能页面(前端 + 后端)
|
||||||
|
|
||||||
|
```
|
||||||
|
请生成完整功能页面:
|
||||||
|
|
||||||
|
【页面信息】
|
||||||
|
页面名称:xxx
|
||||||
|
文件路径:xxx
|
||||||
|
|
||||||
|
【接口信息】
|
||||||
|
接口路径:GET/POST /api/xxx
|
||||||
|
数据表:xxx
|
||||||
|
|
||||||
|
【搜索条件】
|
||||||
|
- 字段(类型)
|
||||||
|
|
||||||
|
【表格列】
|
||||||
|
- 列名(数据字段,渲染类型)
|
||||||
|
|
||||||
|
【操作按钮】
|
||||||
|
- 按钮名称 -> 处理逻辑
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 常用渲染类型
|
||||||
|
|
||||||
|
| 类型 | 说明 | 示例 |
|
||||||
|
|------|------|------|
|
||||||
|
| index | 序号 | 自动计算 |
|
||||||
|
| text | 纯文本 | 直接显示 |
|
||||||
|
| link | 可点击 | 跳转详情 |
|
||||||
|
| count | 统计数 | _count.registrations |
|
||||||
|
| score | 分数 | 保留2位小数 |
|
||||||
|
| tag | 标签 | 状态显示 |
|
||||||
|
| date | 日期 | YYYY-MM-DD HH:mm |
|
||||||
|
| dateRange | 日期范围 | 开始-结束 |
|
||||||
|
| org | 机构信息 | 学校+年级+班级 |
|
||||||
|
| array | 数组拼接 | 用顿号连接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 常用数据字段路径
|
||||||
|
|
||||||
|
| 数据 | 字段路径 |
|
||||||
|
|------|----------|
|
||||||
|
| 用户昵称 | user.nickname |
|
||||||
|
| 用户账号 | user.username |
|
||||||
|
| 学校名称 | user.tenant.name |
|
||||||
|
| 年级名称 | user.student.class.grade.name |
|
||||||
|
| 班级名称 | user.student.class.name |
|
||||||
|
| 指导老师 | teachers[].user.nickname |
|
||||||
|
| 报名人数 | _count.registrations |
|
||||||
|
| 作品数量 | _count.works |
|
||||||
|
| 团队名称 | team.teamName |
|
||||||
261
.claude/skills/backend-api.md
Normal file
261
.claude/skills/backend-api.md
Normal file
@ -0,0 +1,261 @@
|
|||||||
|
# 后端接口生成规范
|
||||||
|
|
||||||
|
## 概述
|
||||||
|
|
||||||
|
本规范用于快速生成 NestJS 后端接口,包含:
|
||||||
|
- Controller(路由定义)
|
||||||
|
- Service(业务逻辑)
|
||||||
|
- DTO(参数校验)
|
||||||
|
- 前端 API 调用
|
||||||
|
|
||||||
|
## 快速生成指令格式
|
||||||
|
|
||||||
|
```
|
||||||
|
请生成后端接口:
|
||||||
|
|
||||||
|
模块名称:xxx
|
||||||
|
接口路径:GET/POST /api/xxx
|
||||||
|
功能描述:xxx
|
||||||
|
|
||||||
|
查询参数:
|
||||||
|
- 参数1(类型,必填/选填)
|
||||||
|
- 参数2(类型,必填/选填)
|
||||||
|
|
||||||
|
返回字段:
|
||||||
|
- 字段1(来源表.字段)
|
||||||
|
- 字段2(关联表.字段)
|
||||||
|
|
||||||
|
关联查询:
|
||||||
|
- 表1 -> 表2(关联字段)
|
||||||
|
|
||||||
|
排序:字段名 + 排序方式
|
||||||
|
分页:是/否
|
||||||
|
```
|
||||||
|
|
||||||
|
## 文件结构
|
||||||
|
|
||||||
|
```
|
||||||
|
backend/src/模块名/
|
||||||
|
├── 模块名.module.ts # 模块定义
|
||||||
|
├── 模块名.controller.ts # 路由控制器
|
||||||
|
├── 模块名.service.ts # 业务逻辑
|
||||||
|
└── dto/
|
||||||
|
├── query-xxx.dto.ts # 查询参数 DTO
|
||||||
|
└── create-xxx.dto.ts # 创建参数 DTO
|
||||||
|
|
||||||
|
frontend/src/api/
|
||||||
|
└── 模块名.ts # 前端 API 调用
|
||||||
|
```
|
||||||
|
|
||||||
|
## Controller 模板
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Controller, Get, Query, Param, UseGuards } from '@nestjs/common';
|
||||||
|
import { JwtAuthGuard } from '../auth/jwt-auth.guard';
|
||||||
|
import { XxxService } from './xxx.service';
|
||||||
|
import { QueryXxxDto } from './dto/query-xxx.dto';
|
||||||
|
|
||||||
|
@Controller('api/xxx')
|
||||||
|
@UseGuards(JwtAuthGuard)
|
||||||
|
export class XxxController {
|
||||||
|
constructor(private readonly xxxService: XxxService) {}
|
||||||
|
|
||||||
|
@Get(':id/list')
|
||||||
|
async getList(
|
||||||
|
@Param('id') id: string,
|
||||||
|
@Query() queryDto: QueryXxxDto,
|
||||||
|
) {
|
||||||
|
return this.xxxService.findAll(+id, queryDto);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Service 模板
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Injectable } from '@nestjs/common';
|
||||||
|
import { PrismaService } from '../prisma/prisma.service';
|
||||||
|
import { QueryXxxDto } from './dto/query-xxx.dto';
|
||||||
|
|
||||||
|
@Injectable()
|
||||||
|
export class XxxService {
|
||||||
|
constructor(private prisma: PrismaService) {}
|
||||||
|
|
||||||
|
async findAll(parentId: number, queryDto: QueryXxxDto) {
|
||||||
|
const { page = 1, pageSize = 10, ...filters } = queryDto;
|
||||||
|
const skip = (page - 1) * pageSize;
|
||||||
|
|
||||||
|
// 构建查询条件
|
||||||
|
const where: any = { parentId };
|
||||||
|
|
||||||
|
if (filters.field1) {
|
||||||
|
where.field1 = { contains: filters.field1 };
|
||||||
|
}
|
||||||
|
|
||||||
|
const [list, total] = await Promise.all([
|
||||||
|
this.prisma.table.findMany({
|
||||||
|
where,
|
||||||
|
skip,
|
||||||
|
take: pageSize,
|
||||||
|
orderBy: { sortField: 'desc' },
|
||||||
|
include: {
|
||||||
|
// 关联查询
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
this.prisma.table.count({ where }),
|
||||||
|
]);
|
||||||
|
|
||||||
|
return { list, total, page, pageSize };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## DTO 模板
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IsOptional, IsString, IsInt, Min } from 'class-validator';
|
||||||
|
import { Type } from 'class-transformer';
|
||||||
|
|
||||||
|
export class QueryXxxDto {
|
||||||
|
@IsOptional()
|
||||||
|
@Type(() => Number)
|
||||||
|
@IsInt()
|
||||||
|
@Min(1)
|
||||||
|
page?: number = 1;
|
||||||
|
|
||||||
|
@IsOptional()
|
||||||
|
@Type(() => Number)
|
||||||
|
@IsInt()
|
||||||
|
@Min(1)
|
||||||
|
pageSize?: number = 10;
|
||||||
|
|
||||||
|
@IsOptional()
|
||||||
|
@IsString()
|
||||||
|
field1?: string;
|
||||||
|
|
||||||
|
@IsOptional()
|
||||||
|
@IsString()
|
||||||
|
field2?: string;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 前端 API 模板
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import request from '@/utils/request'
|
||||||
|
|
||||||
|
export interface QueryXxxParams {
|
||||||
|
page?: number
|
||||||
|
pageSize?: number
|
||||||
|
field1?: string
|
||||||
|
field2?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface XxxItem {
|
||||||
|
id: number
|
||||||
|
// ... 其他字段
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface XxxListResponse {
|
||||||
|
list: XxxItem[]
|
||||||
|
total: number
|
||||||
|
page: number
|
||||||
|
pageSize: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export const xxxApi = {
|
||||||
|
getList(parentId: number, params: QueryXxxParams): Promise<XxxListResponse> {
|
||||||
|
return request.get(`/api/xxx/${parentId}/list`, { params })
|
||||||
|
},
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Prisma 关联查询示例
|
||||||
|
|
||||||
|
### 常用关联模式
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// 用户信息 + 租户 + 学生班级年级
|
||||||
|
user: {
|
||||||
|
include: {
|
||||||
|
tenant: {
|
||||||
|
select: { id: true, name: true },
|
||||||
|
},
|
||||||
|
student: {
|
||||||
|
include: {
|
||||||
|
class: {
|
||||||
|
include: {
|
||||||
|
grade: {
|
||||||
|
select: { id: true, name: true },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
// 指导老师列表
|
||||||
|
teachers: {
|
||||||
|
include: {
|
||||||
|
user: {
|
||||||
|
select: { id: true, username: true, nickname: true },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
// 报名信息 + 用户 + 团队
|
||||||
|
registration: {
|
||||||
|
include: {
|
||||||
|
user: {
|
||||||
|
select: { id: true, username: true, nickname: true },
|
||||||
|
},
|
||||||
|
team: {
|
||||||
|
select: { id: true, teamName: true },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 示例:赛果发布详情接口
|
||||||
|
|
||||||
|
```
|
||||||
|
请生成后端接口:
|
||||||
|
|
||||||
|
模块名称:results(已存在,需修改)
|
||||||
|
接口路径:GET /api/contests/:id/results/works
|
||||||
|
功能描述:获取赛事的作品列表(用于赛果发布)
|
||||||
|
|
||||||
|
查询参数:
|
||||||
|
- page(number,选填,默认1)
|
||||||
|
- pageSize(number,选填,默认10)
|
||||||
|
- workNo(string,选填,作品编号模糊搜索)
|
||||||
|
- accountNo(string,选填,报名账号模糊搜索)
|
||||||
|
|
||||||
|
返回字段:
|
||||||
|
- id, workNo, title, finalScore(作品表)
|
||||||
|
- registration.user.nickname, username(用户表)
|
||||||
|
- registration.user.tenant.name(租户表)
|
||||||
|
- registration.user.student.class.name, grade.name(班级年级)
|
||||||
|
- registration.teachers[].user.nickname(指导老师)
|
||||||
|
|
||||||
|
关联查询:
|
||||||
|
- ContestWork -> ContestRegistration(registrationId)
|
||||||
|
- ContestRegistration -> User(userId)
|
||||||
|
- User -> Tenant(tenantId)
|
||||||
|
- User -> Student -> Class -> Grade
|
||||||
|
- ContestRegistration -> ContestRegistrationTeacher -> User
|
||||||
|
|
||||||
|
排序:finalScore DESC
|
||||||
|
分页:是
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
1. **权限控制**:Controller 需要添加 `@UseGuards(JwtAuthGuard)` 和权限装饰器
|
||||||
|
2. **参数校验**:DTO 使用 class-validator 进行校验
|
||||||
|
3. **分页处理**:统一使用 page/pageSize 参数
|
||||||
|
4. **空值处理**:查询条件为空时不添加到 where 条件
|
||||||
|
5. **关联数据**:使用 Prisma 的 include 进行关联查询
|
||||||
|
6. **性能优化**:只 select 需要的字段,避免查询过多数据
|
||||||
|
7. **错误处理**:Service 层抛出 NestJS 内置异常
|
||||||
310
.claude/skills/contest-detail-page.md
Normal file
310
.claude/skills/contest-detail-page.md
Normal file
@ -0,0 +1,310 @@
|
|||||||
|
# 赛事详情页面生成规范
|
||||||
|
|
||||||
|
## 概述
|
||||||
|
|
||||||
|
本规范用于快速生成赛事管理系统中的详情页面,这类页面具有统一的结构:
|
||||||
|
- 顶部导航栏(返回按钮 + 标题 + 操作按钮)
|
||||||
|
- 搜索表单
|
||||||
|
- 数据表格
|
||||||
|
|
||||||
|
## 页面结构
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────┐
|
||||||
|
│ [← 返回] 页面标题 [操作按钮] │
|
||||||
|
├─────────────────────────────────────────────────┤
|
||||||
|
│ 搜索表单: [搜索条件...] [搜索] [重置] │
|
||||||
|
├─────────────────────────────────────────────────┤
|
||||||
|
│ 数据表格 │
|
||||||
|
│ ┌───┬──────┬──────┬──────┬──────┐ │
|
||||||
|
│ │序号│ 列1 │ 列2 │ 列3 │ 操作 │ │
|
||||||
|
│ ├───┼──────┼──────┼──────┼──────┤ │
|
||||||
|
│ │ 1 │ ... │ ... │ ... │ ... │ │
|
||||||
|
│ └───┴──────┴──────┴──────┴──────┘ │
|
||||||
|
└─────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## 快速生成指令格式
|
||||||
|
|
||||||
|
向 Claude 提供以下格式的指令即可快速生成详情页面:
|
||||||
|
|
||||||
|
```
|
||||||
|
请生成一个详情页面:
|
||||||
|
|
||||||
|
页面名称:xxx
|
||||||
|
文件路径:xxx
|
||||||
|
数据来源:xxx API
|
||||||
|
|
||||||
|
标题:字段名(如 contestName)
|
||||||
|
操作按钮:按钮名称 -> 处理函数
|
||||||
|
|
||||||
|
搜索条件:
|
||||||
|
- 字段1(类型)
|
||||||
|
- 字段2(类型)
|
||||||
|
|
||||||
|
表格列:
|
||||||
|
- 列名1(数据字段)
|
||||||
|
- 列名2(数据字段)
|
||||||
|
- ...
|
||||||
|
|
||||||
|
排序:字段名 + 排序方式(升序/降序)
|
||||||
|
```
|
||||||
|
|
||||||
|
## 配置参数说明
|
||||||
|
|
||||||
|
### 1. 基础配置
|
||||||
|
|
||||||
|
| 参数 | 说明 | 示例 |
|
||||||
|
|------|------|------|
|
||||||
|
| 页面名称 | 显示在标题旁 | 赛果发布详情 |
|
||||||
|
| 文件路径 | Vue 文件位置 | views/contests/results/Detail.vue |
|
||||||
|
| 数据来源 | API 模块 | resultsApi / worksApi |
|
||||||
|
| 标题字段 | 动态标题来源 | record.contestName |
|
||||||
|
| 返回路径 | 返回按钮跳转 | 上一页 / 指定路径 |
|
||||||
|
|
||||||
|
### 2. 操作按钮
|
||||||
|
|
||||||
|
| 属性 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| 名称 | 按钮显示文本 |
|
||||||
|
| 类型 | primary / default / danger |
|
||||||
|
| 处理函数 | 点击触发的方法 |
|
||||||
|
| 确认弹窗 | 是否需要二次确认 |
|
||||||
|
|
||||||
|
### 3. 搜索条件类型
|
||||||
|
|
||||||
|
| 类型 | 说明 | 示例 |
|
||||||
|
|------|------|------|
|
||||||
|
| input | 输入框 | 作品编号、账号 |
|
||||||
|
| select | 下拉选择 | 状态筛选 |
|
||||||
|
| date | 日期选择 | 提交日期 |
|
||||||
|
| dateRange | 日期范围 | 时间区间 |
|
||||||
|
|
||||||
|
### 4. 表格列渲染类型
|
||||||
|
|
||||||
|
| 类型 | 说明 | 示例 |
|
||||||
|
|------|------|------|
|
||||||
|
| index | 序号 | 自动计算 |
|
||||||
|
| text | 纯文本 | 直接显示字段值 |
|
||||||
|
| nested | 嵌套字段 | record.user?.nickname |
|
||||||
|
| array | 数组拼接 | teachers.map(t => t.name).join('、') |
|
||||||
|
| score | 分数格式 | 保留2位小数 |
|
||||||
|
| tag | 标签样式 | 状态标签 |
|
||||||
|
| org | 机构信息 | 学校 + 年级 + 班级 |
|
||||||
|
|
||||||
|
### 5. 排序配置
|
||||||
|
|
||||||
|
| 属性 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| 字段 | 排序依据的字段名 |
|
||||||
|
| 方式 | asc(升序)/ desc(降序)|
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
### 赛果发布详情页
|
||||||
|
|
||||||
|
```
|
||||||
|
请生成一个详情页面:
|
||||||
|
|
||||||
|
页面名称:赛果发布详情
|
||||||
|
文件路径:views/contests/results/Detail.vue
|
||||||
|
数据来源:resultsApi.getResults
|
||||||
|
|
||||||
|
标题:contestName(赛事名称)
|
||||||
|
操作按钮:发布赛果 -> handlePublish(需确认)
|
||||||
|
|
||||||
|
搜索条件:
|
||||||
|
- workNo 作品编号(input)
|
||||||
|
- accountNo 报名账号(input)
|
||||||
|
|
||||||
|
表格列:
|
||||||
|
- 序号(index)
|
||||||
|
- 作品编号(workNo)
|
||||||
|
- 评委评分(finalScore,分数格式)
|
||||||
|
- 姓名(registration.user.nickname)
|
||||||
|
- 账号(registration.user.username)
|
||||||
|
- 机构信息(registration.user,机构格式)
|
||||||
|
- 指导老师(registration.teachers,数组拼接)
|
||||||
|
|
||||||
|
排序:finalScore 降序
|
||||||
|
```
|
||||||
|
|
||||||
|
### 报名记录详情页
|
||||||
|
|
||||||
|
```
|
||||||
|
请生成一个详情页面:
|
||||||
|
|
||||||
|
页面名称:报名记录
|
||||||
|
文件路径:views/contests/registrations/Records.vue
|
||||||
|
数据来源:registrationsApi.getList
|
||||||
|
|
||||||
|
标题:contestName(赛事名称)
|
||||||
|
操作按钮:无
|
||||||
|
|
||||||
|
搜索条件:
|
||||||
|
- accountNo 报名账号(input)
|
||||||
|
- registrationState 审核状态(select)
|
||||||
|
|
||||||
|
表格列:
|
||||||
|
- 序号(index)
|
||||||
|
- 报名账号(accountNo)
|
||||||
|
- 姓名(user.nickname)
|
||||||
|
- 机构信息(user,机构格式)
|
||||||
|
- 指导老师(teachers,数组拼接)
|
||||||
|
- 审核状态(registrationState,标签)
|
||||||
|
- 报名时间(registrationTime,日期)
|
||||||
|
- 操作(查看详情、审核)
|
||||||
|
|
||||||
|
排序:registrationTime 降序
|
||||||
|
```
|
||||||
|
|
||||||
|
## 页面模板代码
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<template>
|
||||||
|
<div class="detail-page">
|
||||||
|
<!-- 顶部导航 -->
|
||||||
|
<div class="page-header">
|
||||||
|
<div class="header-left">
|
||||||
|
<a-button type="text" @click="handleBack">
|
||||||
|
<template #icon><ArrowLeftOutlined /></template>
|
||||||
|
返回
|
||||||
|
</a-button>
|
||||||
|
<span class="page-title">{{ pageTitle }}</span>
|
||||||
|
</div>
|
||||||
|
<div class="header-right">
|
||||||
|
<a-button type="primary" @click="handleAction">
|
||||||
|
{{ actionButtonText }}
|
||||||
|
</a-button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- 搜索表单 -->
|
||||||
|
<a-form
|
||||||
|
:model="searchParams"
|
||||||
|
layout="inline"
|
||||||
|
class="search-form"
|
||||||
|
@finish="handleSearch"
|
||||||
|
>
|
||||||
|
<!-- 根据配置生成搜索项 -->
|
||||||
|
<a-form-item>
|
||||||
|
<a-button type="primary" html-type="submit">
|
||||||
|
<template #icon><SearchOutlined /></template>
|
||||||
|
搜索
|
||||||
|
</a-button>
|
||||||
|
<a-button style="margin-left: 8px" @click="handleReset">
|
||||||
|
<template #icon><ReloadOutlined /></template>
|
||||||
|
重置
|
||||||
|
</a-button>
|
||||||
|
</a-form-item>
|
||||||
|
</a-form>
|
||||||
|
|
||||||
|
<!-- 数据表格 -->
|
||||||
|
<a-table
|
||||||
|
:columns="columns"
|
||||||
|
:data-source="dataSource"
|
||||||
|
:loading="loading"
|
||||||
|
:pagination="pagination"
|
||||||
|
row-key="id"
|
||||||
|
@change="handleTableChange"
|
||||||
|
>
|
||||||
|
<template #bodyCell="{ column, record, index }">
|
||||||
|
<!-- 根据配置生成列渲染 -->
|
||||||
|
</template>
|
||||||
|
</a-table>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 特殊字段渲染规范
|
||||||
|
|
||||||
|
### 机构信息(org 类型)
|
||||||
|
```vue
|
||||||
|
<template v-else-if="column.key === 'org'">
|
||||||
|
<div>
|
||||||
|
<div>{{ record.user?.tenant?.name || "-" }}</div>
|
||||||
|
<div v-if="record.user?.student?.class" class="org-detail">
|
||||||
|
{{ record.user.student.class.grade?.name }}
|
||||||
|
{{ record.user.student.class.name }}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 指导老师(数组拼接)
|
||||||
|
```vue
|
||||||
|
<template v-else-if="column.key === 'teachers'">
|
||||||
|
{{ formatTeachers(record.teachers || record.registration?.teachers) }}
|
||||||
|
</template>
|
||||||
|
|
||||||
|
// 格式化函数
|
||||||
|
const formatTeachers = (teachers: any[]) => {
|
||||||
|
if (!teachers || teachers.length === 0) return "-"
|
||||||
|
return teachers.map(t => t.user?.nickname || t.user?.username).join("、")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 分数格式
|
||||||
|
```vue
|
||||||
|
<template v-else-if="column.key === 'score'">
|
||||||
|
<span v-if="record.finalScore !== null" class="score">
|
||||||
|
{{ Number(record.finalScore).toFixed(2) }}
|
||||||
|
</span>
|
||||||
|
<span v-else>-</span>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 样式规范
|
||||||
|
|
||||||
|
```css
|
||||||
|
.detail-page {
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-header {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
align-items: center;
|
||||||
|
padding: 16px;
|
||||||
|
background: #fff;
|
||||||
|
border-radius: 8px;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.header-left {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-title {
|
||||||
|
font-size: 16px;
|
||||||
|
font-weight: 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-form {
|
||||||
|
margin-bottom: 16px;
|
||||||
|
padding: 16px;
|
||||||
|
background: #fff;
|
||||||
|
border-radius: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.org-detail {
|
||||||
|
font-size: 12px;
|
||||||
|
color: #666;
|
||||||
|
margin-top: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.score {
|
||||||
|
font-weight: bold;
|
||||||
|
color: #52c41a;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
1. **API 数据**:确保后端返回了所需的关联数据(如 user、teachers、tenant、student.class.grade)
|
||||||
|
2. **排序字段**:需要后端支持对应字段的排序
|
||||||
|
3. **权限控制**:操作按钮需要配置权限检查
|
||||||
|
4. **空值处理**:所有字段都需要处理空值情况,显示 "-"
|
||||||
|
5. **嵌套数据**:使用可选链操作符 `?.` 避免空指针错误
|
||||||
449
.claude/skills/contest-list-page.md
Normal file
449
.claude/skills/contest-list-page.md
Normal file
@ -0,0 +1,449 @@
|
|||||||
|
# 赛事列表页面生成规范
|
||||||
|
|
||||||
|
## 概述
|
||||||
|
|
||||||
|
本规范用于快速生成赛事管理系统中的列表页面,这类页面具有统一的结构:
|
||||||
|
- Tab 切换(个人赛/团队赛)
|
||||||
|
- 搜索表单
|
||||||
|
- 数据表格
|
||||||
|
- 操作按钮
|
||||||
|
|
||||||
|
## 页面结构
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────┐
|
||||||
|
│ 标题卡片 (a-card) │
|
||||||
|
├─────────────────────────────────────────────────┤
|
||||||
|
│ Tab栏: [个人赛] [团队赛] │
|
||||||
|
├─────────────────────────────────────────────────┤
|
||||||
|
│ 搜索表单: [搜索条件...] [搜索] [重置] │
|
||||||
|
├─────────────────────────────────────────────────┤
|
||||||
|
│ 数据表格 │
|
||||||
|
│ ┌───┬──────┬──────┬──────┬──────┐ │
|
||||||
|
│ │序号│ 列1 │ 列2 │ 列3 │ 操作 │ │
|
||||||
|
│ ├───┼──────┼──────┼──────┼──────┤ │
|
||||||
|
│ │ 1 │ ... │ ... │ ... │ 详情 │ │
|
||||||
|
│ │ 2 │ ... │ ... │ ... │ 详情 │ │
|
||||||
|
│ └───┴──────┴──────┴──────┴──────┘ │
|
||||||
|
└─────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## 配置参数
|
||||||
|
|
||||||
|
生成页面时需要提供以下配置:
|
||||||
|
|
||||||
|
### 1. 基础配置
|
||||||
|
|
||||||
|
| 参数 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| pageName | string | 是 | 页面名称,如"赛果发布"、"报名管理" |
|
||||||
|
| pageClass | string | 是 | CSS类名,如"results-page" |
|
||||||
|
| routePrefix | string | 是 | 路由前缀,如"results"、"registrations" |
|
||||||
|
| detailRouteName | string | 否 | 详情页路由名称 |
|
||||||
|
|
||||||
|
### 2. 搜索条件配置
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface SearchField {
|
||||||
|
field: string // 字段名
|
||||||
|
label: string // 标签文本
|
||||||
|
type: 'input' | 'select' | 'date' | 'dateRange' // 控件类型
|
||||||
|
placeholder?: string // 占位文本
|
||||||
|
width?: string // 宽度,默认 "200px"
|
||||||
|
options?: Array<{ label: string; value: string }> // select 类型的选项
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**示例**:
|
||||||
|
```typescript
|
||||||
|
const searchFields = [
|
||||||
|
{ field: 'contestName', label: '赛事名称', type: 'input', placeholder: '请输入赛事名称' },
|
||||||
|
{ field: 'status', label: '状态', type: 'select', options: [
|
||||||
|
{ label: '已发布', value: 'published' },
|
||||||
|
{ label: '未发布', value: 'unpublished' }
|
||||||
|
]}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. 表格列配置
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface TableColumn {
|
||||||
|
title: string // 列标题
|
||||||
|
key: string // 列标识
|
||||||
|
dataIndex?: string // 数据字段(简单字段直接映射)
|
||||||
|
width?: number // 列宽度
|
||||||
|
fixed?: 'left' | 'right' // 固定列
|
||||||
|
render?: 'index' | 'link' | 'count' | 'tag' | 'date' | 'dateRange' | 'custom' // 渲染类型
|
||||||
|
renderConfig?: {
|
||||||
|
// link 类型
|
||||||
|
clickHandler?: string // 点击处理函数名
|
||||||
|
// count 类型
|
||||||
|
countField?: string // _count 下的字段名
|
||||||
|
// tag 类型
|
||||||
|
colorMap?: Record<string, string> // 值到颜色的映射
|
||||||
|
textMap?: Record<string, string> // 值到文本的映射
|
||||||
|
// dateRange 类型
|
||||||
|
startField?: string // 开始时间字段
|
||||||
|
endField?: string // 结束时间字段
|
||||||
|
startLabel?: string // 开始标签
|
||||||
|
endLabel?: string // 结束标签
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**常用渲染类型**:
|
||||||
|
|
||||||
|
| 类型 | 说明 | 示例 |
|
||||||
|
|------|------|------|
|
||||||
|
| index | 序号列 | 自动计算 (current-1)*pageSize+index+1 |
|
||||||
|
| link | 可点击链接 | 赛事名称点击跳转 |
|
||||||
|
| count | 统计数量 | record._count?.registrations |
|
||||||
|
| tag | 标签展示 | 状态标签(不同颜色) |
|
||||||
|
| date | 单个日期 | YYYY-MM-DD HH:mm |
|
||||||
|
| dateRange | 日期范围 | 开始:xxx / 结束:xxx |
|
||||||
|
| custom | 自定义渲染 | 需要单独写模板 |
|
||||||
|
|
||||||
|
### 4. 操作按钮配置
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface ActionButton {
|
||||||
|
text: string // 按钮文本
|
||||||
|
type?: 'link' | 'primary' | 'default' // 按钮类型
|
||||||
|
danger?: boolean // 是否危险按钮
|
||||||
|
permission?: string // 权限标识
|
||||||
|
handler: string // 处理函数名
|
||||||
|
disabled?: (record: any) => boolean // 禁用条件
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 页面模板
|
||||||
|
|
||||||
|
### 完整模板代码
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<template>
|
||||||
|
<div class="{{pageClass}}">
|
||||||
|
<a-card class="mb-4">
|
||||||
|
<template #title>{{pageName}}</template>
|
||||||
|
</a-card>
|
||||||
|
|
||||||
|
<!-- Tab栏切换 -->
|
||||||
|
<a-tabs v-model:activeKey="activeTab" @change="handleTabChange">
|
||||||
|
<a-tab-pane key="individual" tab="个人赛" />
|
||||||
|
<a-tab-pane key="team" tab="团队赛" />
|
||||||
|
</a-tabs>
|
||||||
|
|
||||||
|
<!-- 搜索表单 -->
|
||||||
|
<a-form
|
||||||
|
:model="searchParams"
|
||||||
|
layout="inline"
|
||||||
|
class="search-form"
|
||||||
|
@finish="handleSearch"
|
||||||
|
>
|
||||||
|
<!-- 根据 searchFields 配置生成 -->
|
||||||
|
<a-form-item v-for="field in searchFields" :key="field.field" :label="field.label">
|
||||||
|
<!-- input 类型 -->
|
||||||
|
<a-input
|
||||||
|
v-if="field.type === 'input'"
|
||||||
|
v-model:value="searchParams[field.field]"
|
||||||
|
:placeholder="field.placeholder"
|
||||||
|
allow-clear
|
||||||
|
:style="{ width: field.width || '200px' }"
|
||||||
|
/>
|
||||||
|
<!-- select 类型 -->
|
||||||
|
<a-select
|
||||||
|
v-else-if="field.type === 'select'"
|
||||||
|
v-model:value="searchParams[field.field]"
|
||||||
|
:placeholder="field.placeholder"
|
||||||
|
allow-clear
|
||||||
|
:style="{ width: field.width || '150px' }"
|
||||||
|
>
|
||||||
|
<a-select-option
|
||||||
|
v-for="opt in field.options"
|
||||||
|
:key="opt.value"
|
||||||
|
:value="opt.value"
|
||||||
|
>
|
||||||
|
{{ opt.label }}
|
||||||
|
</a-select-option>
|
||||||
|
</a-select>
|
||||||
|
</a-form-item>
|
||||||
|
<a-form-item>
|
||||||
|
<a-button type="primary" html-type="submit">
|
||||||
|
<template #icon><SearchOutlined /></template>
|
||||||
|
搜索
|
||||||
|
</a-button>
|
||||||
|
<a-button style="margin-left: 8px" @click="handleReset">
|
||||||
|
<template #icon><ReloadOutlined /></template>
|
||||||
|
重置
|
||||||
|
</a-button>
|
||||||
|
</a-form-item>
|
||||||
|
</a-form>
|
||||||
|
|
||||||
|
<!-- 数据表格 -->
|
||||||
|
<a-table
|
||||||
|
:columns="columns"
|
||||||
|
:data-source="dataSource"
|
||||||
|
:loading="loading"
|
||||||
|
:pagination="pagination"
|
||||||
|
row-key="id"
|
||||||
|
@change="handleTableChange"
|
||||||
|
>
|
||||||
|
<template #bodyCell="{ column, record, index }">
|
||||||
|
<!-- 根据列配置渲染 -->
|
||||||
|
</template>
|
||||||
|
</a-table>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script setup lang="ts">
|
||||||
|
import { ref, reactive, onMounted } from "vue"
|
||||||
|
import { useRouter, useRoute } from "vue-router"
|
||||||
|
import { message } from "ant-design-vue"
|
||||||
|
import { SearchOutlined, ReloadOutlined } from "@ant-design/icons-vue"
|
||||||
|
import { contestsApi, type Contest, type QueryContestParams } from "@/api/contests"
|
||||||
|
import dayjs from "dayjs"
|
||||||
|
|
||||||
|
const router = useRouter()
|
||||||
|
const route = useRoute()
|
||||||
|
const tenantCode = route.params.tenantCode as string
|
||||||
|
|
||||||
|
// Tab状态
|
||||||
|
const activeTab = ref<"individual" | "team">("individual")
|
||||||
|
|
||||||
|
// 列表状态
|
||||||
|
const loading = ref(false)
|
||||||
|
const dataSource = ref<Contest[]>([])
|
||||||
|
const pagination = reactive({
|
||||||
|
current: 1,
|
||||||
|
pageSize: 10,
|
||||||
|
total: 0,
|
||||||
|
})
|
||||||
|
|
||||||
|
// 搜索参数
|
||||||
|
const searchParams = reactive<QueryContestParams>({
|
||||||
|
contestName: "",
|
||||||
|
})
|
||||||
|
|
||||||
|
// 表格列定义
|
||||||
|
const columns = [
|
||||||
|
// 根据配置生成
|
||||||
|
]
|
||||||
|
|
||||||
|
// 格式化日期
|
||||||
|
const formatDateTime = (dateStr?: string) => {
|
||||||
|
if (!dateStr) return "-"
|
||||||
|
return dayjs(dateStr).format("YYYY-MM-DD HH:mm")
|
||||||
|
}
|
||||||
|
|
||||||
|
// 获取列表数据
|
||||||
|
const fetchList = async () => {
|
||||||
|
loading.value = true
|
||||||
|
try {
|
||||||
|
const params: QueryContestParams = {
|
||||||
|
...searchParams,
|
||||||
|
contestType: activeTab.value,
|
||||||
|
page: pagination.current,
|
||||||
|
pageSize: pagination.pageSize,
|
||||||
|
}
|
||||||
|
const response = await contestsApi.getList(params)
|
||||||
|
dataSource.value = response.list
|
||||||
|
pagination.total = response.total
|
||||||
|
} catch (error) {
|
||||||
|
message.error("获取列表失败")
|
||||||
|
} finally {
|
||||||
|
loading.value = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Tab切换
|
||||||
|
const handleTabChange = () => {
|
||||||
|
pagination.current = 1
|
||||||
|
fetchList()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 搜索
|
||||||
|
const handleSearch = () => {
|
||||||
|
pagination.current = 1
|
||||||
|
fetchList()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 重置
|
||||||
|
const handleReset = () => {
|
||||||
|
// 重置所有搜索参数
|
||||||
|
pagination.current = 1
|
||||||
|
fetchList()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 表格变化
|
||||||
|
const handleTableChange = (pag: any) => {
|
||||||
|
pagination.current = pag.current
|
||||||
|
pagination.pageSize = pag.pageSize
|
||||||
|
fetchList()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 查看详情
|
||||||
|
const handleViewDetail = (record: Contest) => {
|
||||||
|
router.push(`/${tenantCode}/contests/{{routePrefix}}/${record.id}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
fetchList()
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.{{pageClass}} {
|
||||||
|
.search-form {
|
||||||
|
margin-bottom: 16px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用示例
|
||||||
|
|
||||||
|
### 示例1:赛果发布列表
|
||||||
|
|
||||||
|
**配置**:
|
||||||
|
```yaml
|
||||||
|
pageName: 赛果发布
|
||||||
|
pageClass: results-page
|
||||||
|
routePrefix: results
|
||||||
|
|
||||||
|
searchFields:
|
||||||
|
- field: contestName
|
||||||
|
label: 赛事名称
|
||||||
|
type: input
|
||||||
|
placeholder: 请输入赛事名称
|
||||||
|
|
||||||
|
columns:
|
||||||
|
- title: 序号
|
||||||
|
key: index
|
||||||
|
width: 70
|
||||||
|
render: index
|
||||||
|
|
||||||
|
- title: 赛事名称
|
||||||
|
key: contestName
|
||||||
|
dataIndex: contestName
|
||||||
|
width: 200
|
||||||
|
|
||||||
|
- title: 报名人数
|
||||||
|
key: registrationCount
|
||||||
|
width: 100
|
||||||
|
render: count
|
||||||
|
renderConfig:
|
||||||
|
countField: registrations
|
||||||
|
|
||||||
|
- title: 提交作品数
|
||||||
|
key: worksCount
|
||||||
|
width: 100
|
||||||
|
render: count
|
||||||
|
renderConfig:
|
||||||
|
countField: works
|
||||||
|
|
||||||
|
- title: 操作
|
||||||
|
key: action
|
||||||
|
width: 100
|
||||||
|
fixed: right
|
||||||
|
|
||||||
|
actions:
|
||||||
|
- text: 详情
|
||||||
|
handler: handleViewDetail
|
||||||
|
```
|
||||||
|
|
||||||
|
### 示例2:报名管理列表
|
||||||
|
|
||||||
|
**配置**:
|
||||||
|
```yaml
|
||||||
|
pageName: 报名管理
|
||||||
|
pageClass: registrations-page
|
||||||
|
routePrefix: registrations
|
||||||
|
|
||||||
|
searchFields:
|
||||||
|
- field: contestName
|
||||||
|
label: 赛事名称
|
||||||
|
type: input
|
||||||
|
placeholder: 请输入赛事名称
|
||||||
|
|
||||||
|
columns:
|
||||||
|
- title: 序号
|
||||||
|
key: index
|
||||||
|
width: 70
|
||||||
|
render: index
|
||||||
|
|
||||||
|
- title: 赛事名称
|
||||||
|
key: contestName
|
||||||
|
dataIndex: contestName
|
||||||
|
width: 250
|
||||||
|
|
||||||
|
- title: 主办单位
|
||||||
|
key: organizers
|
||||||
|
width: 200
|
||||||
|
render: custom # 需要格式化JSON数组
|
||||||
|
|
||||||
|
- title: 报名人数
|
||||||
|
key: registrationCount
|
||||||
|
width: 120
|
||||||
|
render: count
|
||||||
|
renderConfig:
|
||||||
|
countField: registrations
|
||||||
|
|
||||||
|
- title: 报名时间
|
||||||
|
key: registerTime
|
||||||
|
width: 200
|
||||||
|
render: dateRange
|
||||||
|
renderConfig:
|
||||||
|
startField: registerStartTime
|
||||||
|
endField: registerEndTime
|
||||||
|
startLabel: 开始
|
||||||
|
endLabel: 结束
|
||||||
|
|
||||||
|
- title: 操作
|
||||||
|
key: action
|
||||||
|
width: 220
|
||||||
|
fixed: right
|
||||||
|
|
||||||
|
actions:
|
||||||
|
- text: 报名记录
|
||||||
|
handler: handleViewRecords
|
||||||
|
- text: 启动报名
|
||||||
|
handler: handleStartRegistration
|
||||||
|
permission: contest:update
|
||||||
|
- text: 关闭报名
|
||||||
|
handler: handleStopRegistration
|
||||||
|
permission: contest:update
|
||||||
|
danger: true
|
||||||
|
```
|
||||||
|
|
||||||
|
## 快速生成指令
|
||||||
|
|
||||||
|
向 Claude 提供以下格式的指令即可快速生成页面:
|
||||||
|
|
||||||
|
```
|
||||||
|
请生成一个赛事列表页面:
|
||||||
|
|
||||||
|
页面名称:赛果发布
|
||||||
|
路由前缀:results
|
||||||
|
文件路径:frontend/src/views/contests/results/Index.vue
|
||||||
|
|
||||||
|
搜索条件:
|
||||||
|
- 赛事名称(输入框)
|
||||||
|
|
||||||
|
表格列:
|
||||||
|
- 序号
|
||||||
|
- 赛事名称
|
||||||
|
- 报名人数(_count.registrations)
|
||||||
|
- 提交作品数(_count.works)
|
||||||
|
- 操作(详情按钮)
|
||||||
|
|
||||||
|
详情跳转:/${tenantCode}/contests/results/${record.id}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
1. **API 数据**:确保后端 API 返回了所需的统计字段(如 `_count`)
|
||||||
|
2. **路由配置**:生成页面后需要在 `router/index.ts` 中配置路由
|
||||||
|
3. **权限控制**:操作按钮需要配置 `v-permission` 指令
|
||||||
|
4. **样式一致性**:使用 Ant Design Vue 组件,保持系统风格统一
|
||||||
|
5. **团队赛差异**:如果个人赛和团队赛的列不同,需要定义两套 columns
|
||||||
462
.claude/skills/design-system/SKILL.md
Normal file
462
.claude/skills/design-system/SKILL.md
Normal file
@ -0,0 +1,462 @@
|
|||||||
|
---
|
||||||
|
name: design-system
|
||||||
|
description: "比赛管理系统设计规范。当用户提出页面开发需求时自动应用。主色: #0958d9 蓝色主题。包含: 颜色系统、间距、圆角、阴影、字体、组件规范(按钮、卡片、表单、标签)、页面布局、动画效果。适用: 新增页面、修改样式、组件开发、UI调整。"
|
||||||
|
---
|
||||||
|
|
||||||
|
# 比赛管理系统 - 设计规范 Skill
|
||||||
|
|
||||||
|
当用户提出页面开发、UI修改、组件创建等需求时,**必须遵循以下设计规范**。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 快速开始
|
||||||
|
|
||||||
|
每个新页面的 `<style scoped lang="scss">` 开头必须包含以下变量:
|
||||||
|
|
||||||
|
```scss
|
||||||
|
// ==========================================
|
||||||
|
// 项目统一设计变量 - 必须复制
|
||||||
|
// ==========================================
|
||||||
|
$primary: #1890ff;
|
||||||
|
$primary-dark: #0958d9;
|
||||||
|
$primary-light: #40a9ff;
|
||||||
|
$secondary: #4096ff;
|
||||||
|
$success: #52c41a;
|
||||||
|
$warning: #faad14;
|
||||||
|
$error: #ff4d4f;
|
||||||
|
|
||||||
|
$background: #f5f7fa;
|
||||||
|
$surface: #ffffff;
|
||||||
|
|
||||||
|
$text: rgba(0, 0, 0, 0.85);
|
||||||
|
$text-secondary: rgba(0, 0, 0, 0.65);
|
||||||
|
$text-muted: rgba(0, 0, 0, 0.45);
|
||||||
|
|
||||||
|
$border: #d9d9d9;
|
||||||
|
$border-light: #e8e8e8;
|
||||||
|
|
||||||
|
$gradient-primary: linear-gradient(135deg, $primary 0%, $primary-dark 100%);
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 色彩系统
|
||||||
|
|
||||||
|
### 主色(蓝色主题)
|
||||||
|
|
||||||
|
| 变量 | 色值 | 用途 |
|
||||||
|
|------|------|------|
|
||||||
|
| `$primary` | `#1890ff` | 主色、按钮、链接 |
|
||||||
|
| `$primary-dark` | `#0958d9` | 渐变深色、激活态 |
|
||||||
|
| `$primary-light` | `#40a9ff` | 悬停态、浅色 |
|
||||||
|
| `$secondary` | `#4096ff` | 辅助蓝 |
|
||||||
|
|
||||||
|
### 功能色
|
||||||
|
|
||||||
|
| 变量 | 色值 | 用途 |
|
||||||
|
|------|------|------|
|
||||||
|
| `$success` | `#52c41a` | 成功状态 |
|
||||||
|
| `$warning` | `#faad14` | 警告状态 |
|
||||||
|
| `$error` | `#ff4d4f` | 错误状态 |
|
||||||
|
|
||||||
|
### 中性色
|
||||||
|
|
||||||
|
| 变量 | 色值 | 用途 |
|
||||||
|
|------|------|------|
|
||||||
|
| `$background` | `#f5f5f5` | 页面背景 |
|
||||||
|
| `$surface` | `#ffffff` | 卡片/容器背景 |
|
||||||
|
| `$text` | `rgba(0,0,0,0.85)` | 主文本 |
|
||||||
|
| `$text-secondary` | `rgba(0,0,0,0.65)` | 次要文本 |
|
||||||
|
| `$text-muted` | `rgba(0,0,0,0.45)` | 弱化文本 |
|
||||||
|
| `$border-light` | `#e8e8e8` | 边框 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 间距规范
|
||||||
|
|
||||||
|
基于 **8px** 基准:
|
||||||
|
|
||||||
|
| 尺寸 | 值 | 场景 |
|
||||||
|
|------|------|------|
|
||||||
|
| xs | 4px | 图标间距 |
|
||||||
|
| sm | 8px | 元素内间距 |
|
||||||
|
| md | 12px | 卡片内元素 |
|
||||||
|
| base | 16px | 最常用 |
|
||||||
|
| lg | 20px | 区块间距 |
|
||||||
|
| xl | 24px | 大间距 |
|
||||||
|
| 2xl | 32px | 模块分隔 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 圆角规范
|
||||||
|
|
||||||
|
| 尺寸 | 值 | 场景 |
|
||||||
|
|------|------|------|
|
||||||
|
| sm | 4px | 小元素 |
|
||||||
|
| base | 6px | 默认 |
|
||||||
|
| md | 8px | 卡片 |
|
||||||
|
| lg | 10px | 返回按钮 |
|
||||||
|
| xl | 12px | 大卡片 |
|
||||||
|
| pill | 20px | 标签 |
|
||||||
|
| full | 50% | 头像 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 阴影规范
|
||||||
|
|
||||||
|
| 等级 | 定义 | 场景 |
|
||||||
|
|------|------|------|
|
||||||
|
| sm | `0 1px 2px rgba(0,0,0,0.03)` | 轻微 |
|
||||||
|
| base | `0 2px 8px rgba(0,0,0,0.06)` | 卡片默认 |
|
||||||
|
| md | `0 4px 12px rgba(0,0,0,0.08)` | 悬停 |
|
||||||
|
| lg | `0 8px 24px rgba(0,0,0,0.12)` | 弹窗 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 字体规范
|
||||||
|
|
||||||
|
| 层级 | 大小 | 权重 | 场景 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| h1 | 36px | 700 | 大标题 |
|
||||||
|
| h2 | 26px | 700 | 区块标题 |
|
||||||
|
| h3 | 22px | 600 | 卡片标题 |
|
||||||
|
| h4 | 18px | 600 | 小标题 |
|
||||||
|
| body | 14px | 400 | 正文 |
|
||||||
|
| small | 12px | 400 | 标签 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 组件规范
|
||||||
|
|
||||||
|
### 返回按钮(统一样式)
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.back-btn {
|
||||||
|
width: 40px;
|
||||||
|
height: 40px;
|
||||||
|
border-radius: 10px !important;
|
||||||
|
border: 1px solid rgba($primary, 0.3) !important;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
transition: all 0.3s ease !important;
|
||||||
|
|
||||||
|
&:hover {
|
||||||
|
background: rgba($primary, 0.1) !important;
|
||||||
|
border-color: $primary !important;
|
||||||
|
transform: translateY(-1px);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
模板代码:
|
||||||
|
```vue
|
||||||
|
<a-button type="text" class="back-btn" @click="handleBack">
|
||||||
|
<template #icon><ArrowLeftOutlined /></template>
|
||||||
|
</a-button>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 主按钮(渐变样式)
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.primary-btn,
|
||||||
|
.gradient-btn {
|
||||||
|
background: linear-gradient(135deg, $primary 0%, $primary-dark 100%) !important;
|
||||||
|
border: none !important;
|
||||||
|
color: #fff !important;
|
||||||
|
font-weight: 500 !important;
|
||||||
|
border-radius: 20px !important;
|
||||||
|
padding: 6px 16px !important;
|
||||||
|
transition: all 0.3s ease !important;
|
||||||
|
box-shadow: 0 2px 8px rgba($primary, 0.3);
|
||||||
|
|
||||||
|
&:hover {
|
||||||
|
transform: translateY(-2px);
|
||||||
|
box-shadow: 0 6px 20px rgba($primary, 0.4);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 用于 hero 区域的大按钮
|
||||||
|
.action-btn.primary {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
padding: 12px 28px;
|
||||||
|
border-radius: 24px;
|
||||||
|
font-size: 15px;
|
||||||
|
font-weight: 600;
|
||||||
|
background: linear-gradient(135deg, $primary 0%, $primary-dark 100%);
|
||||||
|
color: #fff;
|
||||||
|
border: none;
|
||||||
|
cursor: pointer;
|
||||||
|
box-shadow: 0 4px 15px rgba($primary, 0.4);
|
||||||
|
transition: all 0.3s;
|
||||||
|
|
||||||
|
&:hover {
|
||||||
|
transform: translateY(-2px);
|
||||||
|
box-shadow: 0 6px 20px rgba($primary, 0.5);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 卡片
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.card {
|
||||||
|
background: $surface;
|
||||||
|
border: 1px solid $border-light;
|
||||||
|
border-radius: 8px;
|
||||||
|
padding: 16px;
|
||||||
|
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.06);
|
||||||
|
transition: all 0.3s ease;
|
||||||
|
|
||||||
|
&:hover {
|
||||||
|
border-color: rgba($primary, 0.3);
|
||||||
|
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.08);
|
||||||
|
transform: translateY(-4px);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 标签
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.tag {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
padding: 4px 12px;
|
||||||
|
border-radius: 20px;
|
||||||
|
font-size: 12px;
|
||||||
|
font-weight: 600;
|
||||||
|
|
||||||
|
&.tag-success {
|
||||||
|
background: rgba($success, 0.1);
|
||||||
|
color: $success;
|
||||||
|
border: 1px solid rgba($success, 0.3);
|
||||||
|
}
|
||||||
|
|
||||||
|
&.tag-primary {
|
||||||
|
background: rgba($primary, 0.1);
|
||||||
|
color: $primary;
|
||||||
|
border: 1px solid rgba($primary, 0.3);
|
||||||
|
}
|
||||||
|
|
||||||
|
&.tag-error {
|
||||||
|
background: rgba($error, 0.1);
|
||||||
|
color: $error;
|
||||||
|
border: 1px solid rgba($error, 0.3);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 面板/浮层
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.panel {
|
||||||
|
background: rgba($surface, 0.85);
|
||||||
|
backdrop-filter: blur(20px);
|
||||||
|
border: 1px solid rgba($primary, 0.2);
|
||||||
|
border-radius: 12px;
|
||||||
|
|
||||||
|
.panel-header {
|
||||||
|
padding: 14px 16px;
|
||||||
|
background: rgba($primary, 0.05);
|
||||||
|
border-bottom: 1px solid rgba($primary, 0.1);
|
||||||
|
}
|
||||||
|
|
||||||
|
.panel-body {
|
||||||
|
padding: 16px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 页面布局规范
|
||||||
|
|
||||||
|
### 页面头部(64px 高)
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.page-header {
|
||||||
|
height: 64px;
|
||||||
|
padding: 0 24px;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: space-between;
|
||||||
|
background: $surface;
|
||||||
|
border-bottom: 1px solid #e8e8e8;
|
||||||
|
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.04);
|
||||||
|
position: relative;
|
||||||
|
z-index: 10;
|
||||||
|
|
||||||
|
.header-left {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.title {
|
||||||
|
font-size: 18px;
|
||||||
|
font-weight: 600;
|
||||||
|
background: $gradient-primary;
|
||||||
|
-webkit-background-clip: text;
|
||||||
|
-webkit-text-fill-color: transparent;
|
||||||
|
background-clip: text;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 全屏页面容器
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.fullscreen-page {
|
||||||
|
min-height: 100vh;
|
||||||
|
background: $background;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
position: relative;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-content {
|
||||||
|
flex: 1;
|
||||||
|
padding: 24px;
|
||||||
|
overflow: auto;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 卡片网格
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.card-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(auto-fill, minmax(240px, 1fr));
|
||||||
|
gap: 20px;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 动画规范
|
||||||
|
|
||||||
|
### 过渡时间
|
||||||
|
|
||||||
|
- 标准过渡:`0.3s ease`
|
||||||
|
- 所有交互元素必须添加过渡
|
||||||
|
|
||||||
|
### 悬停效果
|
||||||
|
|
||||||
|
```scss
|
||||||
|
// 卡片悬停
|
||||||
|
transform: translateY(-4px);
|
||||||
|
|
||||||
|
// 按钮悬停
|
||||||
|
transform: translateY(-2px);
|
||||||
|
|
||||||
|
// 小元素悬停
|
||||||
|
transform: translateY(-1px);
|
||||||
|
```
|
||||||
|
|
||||||
|
### 常用动画
|
||||||
|
|
||||||
|
```scss
|
||||||
|
// 脉冲
|
||||||
|
@keyframes pulse {
|
||||||
|
0%, 100% { opacity: 1; transform: scale(1); }
|
||||||
|
50% { opacity: 0.5; transform: scale(0.8); }
|
||||||
|
}
|
||||||
|
|
||||||
|
// 旋转
|
||||||
|
@keyframes spin {
|
||||||
|
to { transform: rotate(360deg); }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 加载/错误状态
|
||||||
|
|
||||||
|
### 加载遮罩
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.loading-overlay {
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
background: $background;
|
||||||
|
z-index: 10;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 错误卡片
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.error-card {
|
||||||
|
text-align: center;
|
||||||
|
padding: 40px;
|
||||||
|
background: $surface;
|
||||||
|
border: 1px solid #e8e8e8;
|
||||||
|
border-radius: 16px;
|
||||||
|
|
||||||
|
.error-icon {
|
||||||
|
width: 60px;
|
||||||
|
height: 60px;
|
||||||
|
margin: 0 auto 20px;
|
||||||
|
background: $error;
|
||||||
|
border-radius: 50%;
|
||||||
|
color: #fff;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 滚动条
|
||||||
|
|
||||||
|
```scss
|
||||||
|
&::-webkit-scrollbar {
|
||||||
|
width: 6px;
|
||||||
|
}
|
||||||
|
&::-webkit-scrollbar-track {
|
||||||
|
background: rgba($primary, 0.05);
|
||||||
|
}
|
||||||
|
&::-webkit-scrollbar-thumb {
|
||||||
|
background: rgba($primary, 0.3);
|
||||||
|
border-radius: 3px;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 响应式断点
|
||||||
|
|
||||||
|
```scss
|
||||||
|
$breakpoint-sm: 640px;
|
||||||
|
$breakpoint-md: 768px;
|
||||||
|
$breakpoint-lg: 1024px;
|
||||||
|
$breakpoint-xl: 1280px;
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 开发检查清单
|
||||||
|
|
||||||
|
新增页面必须确认:
|
||||||
|
|
||||||
|
- [ ] 复制了颜色变量到 style 开头
|
||||||
|
- [ ] 返回按钮使用 40x40px + 10px 圆角
|
||||||
|
- [ ] 卡片悬停有 `translateY(-4px)` 效果
|
||||||
|
- [ ] 页面头部高度 64px
|
||||||
|
- [ ] 所有过渡动画 0.3s
|
||||||
|
- [ ] 使用 `$gradient-primary` 作为主渐变
|
||||||
|
- [ ] 加载状态使用蓝色系
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 参考页面
|
||||||
|
|
||||||
|
- `frontend/src/views/workbench/ai-3d/Index.vue` - 3D Lab 主页
|
||||||
|
- `frontend/src/views/workbench/ai-3d/Generate.vue` - 生成页
|
||||||
|
- `frontend/src/views/model/ModelViewer.vue` - 模型预览页
|
||||||
228
.claude/skills/ui-ux-pro-max/SKILL.md
Normal file
228
.claude/skills/ui-ux-pro-max/SKILL.md
Normal file
@ -0,0 +1,228 @@
|
|||||||
|
---
|
||||||
|
name: ui-ux-pro-max
|
||||||
|
description: "UI/UX design intelligence. 50 styles, 21 palettes, 50 font pairings, 20 charts, 8 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, mobile app, .html, .tsx, .vue, .svelte. Elements: button, modal, navbar, sidebar, card, table, form, chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, flat design. Topics: color palette, accessibility, animation, layout, typography, font pairing, spacing, hover, shadow, gradient."
|
||||||
|
---
|
||||||
|
|
||||||
|
# UI/UX Pro Max - Design Intelligence
|
||||||
|
|
||||||
|
Searchable database of UI styles, color palettes, font pairings, chart types, product recommendations, UX guidelines, and stack-specific best practices.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
Check if Python is installed:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 --version || python --version
|
||||||
|
```
|
||||||
|
|
||||||
|
If Python is not installed, install it based on user's OS:
|
||||||
|
|
||||||
|
**macOS:**
|
||||||
|
```bash
|
||||||
|
brew install python3
|
||||||
|
```
|
||||||
|
|
||||||
|
**Ubuntu/Debian:**
|
||||||
|
```bash
|
||||||
|
sudo apt update && sudo apt install python3
|
||||||
|
```
|
||||||
|
|
||||||
|
**Windows:**
|
||||||
|
```powershell
|
||||||
|
winget install Python.Python.3.12
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How to Use This Skill
|
||||||
|
|
||||||
|
When user requests UI/UX work (design, build, create, implement, review, fix, improve), follow this workflow:
|
||||||
|
|
||||||
|
### Step 1: Analyze User Requirements
|
||||||
|
|
||||||
|
Extract key information from user request:
|
||||||
|
- **Product type**: SaaS, e-commerce, portfolio, dashboard, landing page, etc.
|
||||||
|
- **Style keywords**: minimal, playful, professional, elegant, dark mode, etc.
|
||||||
|
- **Industry**: healthcare, fintech, gaming, education, etc.
|
||||||
|
- **Stack**: React, Vue, Next.js, or default to `html-tailwind`
|
||||||
|
|
||||||
|
### Step 2: Search Relevant Domains
|
||||||
|
|
||||||
|
Use `search.py` multiple times to gather comprehensive information. Search until you have enough context.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "<keyword>" --domain <domain> [-n <max_results>]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Recommended search order:**
|
||||||
|
|
||||||
|
1. **Product** - Get style recommendations for product type
|
||||||
|
2. **Style** - Get detailed style guide (colors, effects, frameworks)
|
||||||
|
3. **Typography** - Get font pairings with Google Fonts imports
|
||||||
|
4. **Color** - Get color palette (Primary, Secondary, CTA, Background, Text, Border)
|
||||||
|
5. **Landing** - Get page structure (if landing page)
|
||||||
|
6. **Chart** - Get chart recommendations (if dashboard/analytics)
|
||||||
|
7. **UX** - Get best practices and anti-patterns
|
||||||
|
8. **Stack** - Get stack-specific guidelines (default: html-tailwind)
|
||||||
|
|
||||||
|
### Step 3: Stack Guidelines (Default: html-tailwind)
|
||||||
|
|
||||||
|
If user doesn't specify a stack, **default to `html-tailwind`**.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "<keyword>" --stack html-tailwind
|
||||||
|
```
|
||||||
|
|
||||||
|
Available stacks: `html-tailwind`, `react`, `nextjs`, `vue`, `svelte`, `swiftui`, `react-native`, `flutter`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Search Reference
|
||||||
|
|
||||||
|
### Available Domains
|
||||||
|
|
||||||
|
| Domain | Use For | Example Keywords |
|
||||||
|
|--------|---------|------------------|
|
||||||
|
| `product` | Product type recommendations | SaaS, e-commerce, portfolio, healthcare, beauty, service |
|
||||||
|
| `style` | UI styles, colors, effects | glassmorphism, minimalism, dark mode, brutalism |
|
||||||
|
| `typography` | Font pairings, Google Fonts | elegant, playful, professional, modern |
|
||||||
|
| `color` | Color palettes by product type | saas, ecommerce, healthcare, beauty, fintech, service |
|
||||||
|
| `landing` | Page structure, CTA strategies | hero, hero-centric, testimonial, pricing, social-proof |
|
||||||
|
| `chart` | Chart types, library recommendations | trend, comparison, timeline, funnel, pie |
|
||||||
|
| `ux` | Best practices, anti-patterns | animation, accessibility, z-index, loading |
|
||||||
|
| `prompt` | AI prompts, CSS keywords | (style name) |
|
||||||
|
|
||||||
|
### Available Stacks
|
||||||
|
|
||||||
|
| Stack | Focus |
|
||||||
|
|-------|-------|
|
||||||
|
| `html-tailwind` | Tailwind utilities, responsive, a11y (DEFAULT) |
|
||||||
|
| `react` | State, hooks, performance, patterns |
|
||||||
|
| `nextjs` | SSR, routing, images, API routes |
|
||||||
|
| `vue` | Composition API, Pinia, Vue Router |
|
||||||
|
| `svelte` | Runes, stores, SvelteKit |
|
||||||
|
| `swiftui` | Views, State, Navigation, Animation |
|
||||||
|
| `react-native` | Components, Navigation, Lists |
|
||||||
|
| `flutter` | Widgets, State, Layout, Theming |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Example Workflow
|
||||||
|
|
||||||
|
**User request:** "Làm landing page cho dịch vụ chăm sóc da chuyên nghiệp"
|
||||||
|
|
||||||
|
**AI should:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. Search product type
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "beauty spa wellness service" --domain product
|
||||||
|
|
||||||
|
# 2. Search style (based on industry: beauty, elegant)
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "elegant minimal soft" --domain style
|
||||||
|
|
||||||
|
# 3. Search typography
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "elegant luxury" --domain typography
|
||||||
|
|
||||||
|
# 4. Search color palette
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "beauty spa wellness" --domain color
|
||||||
|
|
||||||
|
# 5. Search landing page structure
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "hero-centric social-proof" --domain landing
|
||||||
|
|
||||||
|
# 6. Search UX guidelines
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "animation" --domain ux
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "accessibility" --domain ux
|
||||||
|
|
||||||
|
# 7. Search stack guidelines (default: html-tailwind)
|
||||||
|
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "layout responsive" --stack html-tailwind
|
||||||
|
```
|
||||||
|
|
||||||
|
**Then:** Synthesize all search results and implement the design.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Tips for Better Results
|
||||||
|
|
||||||
|
1. **Be specific with keywords** - "healthcare SaaS dashboard" > "app"
|
||||||
|
2. **Search multiple times** - Different keywords reveal different insights
|
||||||
|
3. **Combine domains** - Style + Typography + Color = Complete design system
|
||||||
|
4. **Always check UX** - Search "animation", "z-index", "accessibility" for common issues
|
||||||
|
5. **Use stack flag** - Get implementation-specific best practices
|
||||||
|
6. **Iterate** - If first search doesn't match, try different keywords
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Rules for Professional UI
|
||||||
|
|
||||||
|
These are frequently overlooked issues that make UI look unprofessional:
|
||||||
|
|
||||||
|
### Icons & Visual Elements
|
||||||
|
|
||||||
|
| Rule | Do | Don't |
|
||||||
|
|------|----|----- |
|
||||||
|
| **No emoji icons** | Use SVG icons (Heroicons, Lucide, Simple Icons) | Use emojis like 🎨 🚀 ⚙️ as UI icons |
|
||||||
|
| **Stable hover states** | Use color/opacity transitions on hover | Use scale transforms that shift layout |
|
||||||
|
| **Correct brand logos** | Research official SVG from Simple Icons | Guess or use incorrect logo paths |
|
||||||
|
| **Consistent icon sizing** | Use fixed viewBox (24x24) with w-6 h-6 | Mix different icon sizes randomly |
|
||||||
|
|
||||||
|
### Interaction & Cursor
|
||||||
|
|
||||||
|
| Rule | Do | Don't |
|
||||||
|
|------|----|----- |
|
||||||
|
| **Cursor pointer** | Add `cursor-pointer` to all clickable/hoverable cards | Leave default cursor on interactive elements |
|
||||||
|
| **Hover feedback** | Provide visual feedback (color, shadow, border) | No indication element is interactive |
|
||||||
|
| **Smooth transitions** | Use `transition-colors duration-200` | Instant state changes or too slow (>500ms) |
|
||||||
|
|
||||||
|
### Light/Dark Mode Contrast
|
||||||
|
|
||||||
|
| Rule | Do | Don't |
|
||||||
|
|------|----|----- |
|
||||||
|
| **Glass card light mode** | Use `bg-white/80` or higher opacity | Use `bg-white/10` (too transparent) |
|
||||||
|
| **Text contrast light** | Use `#0F172A` (slate-900) for text | Use `#94A3B8` (slate-400) for body text |
|
||||||
|
| **Muted text light** | Use `#475569` (slate-600) minimum | Use gray-400 or lighter |
|
||||||
|
| **Border visibility** | Use `border-gray-200` in light mode | Use `border-white/10` (invisible) |
|
||||||
|
|
||||||
|
### Layout & Spacing
|
||||||
|
|
||||||
|
| Rule | Do | Don't |
|
||||||
|
|------|----|----- |
|
||||||
|
| **Floating navbar** | Add `top-4 left-4 right-4` spacing | Stick navbar to `top-0 left-0 right-0` |
|
||||||
|
| **Content padding** | Account for fixed navbar height | Let content hide behind fixed elements |
|
||||||
|
| **Consistent max-width** | Use same `max-w-6xl` or `max-w-7xl` | Mix different container widths |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Pre-Delivery Checklist
|
||||||
|
|
||||||
|
Before delivering UI code, verify these items:
|
||||||
|
|
||||||
|
### Visual Quality
|
||||||
|
- [ ] No emojis used as icons (use SVG instead)
|
||||||
|
- [ ] All icons from consistent icon set (Heroicons/Lucide)
|
||||||
|
- [ ] Brand logos are correct (verified from Simple Icons)
|
||||||
|
- [ ] Hover states don't cause layout shift
|
||||||
|
- [ ] Use theme colors directly (bg-primary) not var() wrapper
|
||||||
|
|
||||||
|
### Interaction
|
||||||
|
- [ ] All clickable elements have `cursor-pointer`
|
||||||
|
- [ ] Hover states provide clear visual feedback
|
||||||
|
- [ ] Transitions are smooth (150-300ms)
|
||||||
|
- [ ] Focus states visible for keyboard navigation
|
||||||
|
|
||||||
|
### Light/Dark Mode
|
||||||
|
- [ ] Light mode text has sufficient contrast (4.5:1 minimum)
|
||||||
|
- [ ] Glass/transparent elements visible in light mode
|
||||||
|
- [ ] Borders visible in both modes
|
||||||
|
- [ ] Test both modes before delivery
|
||||||
|
|
||||||
|
### Layout
|
||||||
|
- [ ] Floating elements have proper spacing from edges
|
||||||
|
- [ ] No content hidden behind fixed navbars
|
||||||
|
- [ ] Responsive at 320px, 768px, 1024px, 1440px
|
||||||
|
- [ ] No horizontal scroll on mobile
|
||||||
|
|
||||||
|
### Accessibility
|
||||||
|
- [ ] All images have alt text
|
||||||
|
- [ ] Form inputs have labels
|
||||||
|
- [ ] Color is not the only indicator
|
||||||
|
- [ ] `prefers-reduced-motion` respected
|
||||||
26
.claude/skills/ui-ux-pro-max/data/charts.csv
Normal file
26
.claude/skills/ui-ux-pro-max/data/charts.csv
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
No,Data Type,Keywords,Best Chart Type,Secondary Options,Color Guidance,Performance Impact,Accessibility Notes,Library Recommendation,Interactive Level
|
||||||
|
1,Trend Over Time,"trend, time-series, line, growth, timeline, progress",Line Chart,"Area Chart, Smooth Area",Primary: #0080FF. Multiple series: use distinct colors. Fill: 20% opacity,⚡ Excellent (optimized),✓ Clear line patterns for colorblind users. Add pattern overlays.,"Chart.js, Recharts, ApexCharts",Hover + Zoom
|
||||||
|
2,Compare Categories,"compare, categories, bar, comparison, ranking",Bar Chart (Horizontal or Vertical),"Column Chart, Grouped Bar",Each bar: distinct color. Category: grouped same color. Sorted: descending order,⚡ Excellent,✓ Easy to compare. Add value labels on bars for clarity.,"Chart.js, Recharts, D3.js",Hover + Sort
|
||||||
|
3,Part-to-Whole,"part-to-whole, pie, donut, percentage, proportion, share",Pie Chart or Donut,"Stacked Bar, Treemap",Colors: 5-6 max. Contrasting palette. Large slices first. Use labels.,⚡ Good (limit 6 slices),⚠ Hard for accessibility. Better: Stacked bar with legend. Avoid pie if >5 items.,"Chart.js, Recharts, D3.js",Hover + Drill
|
||||||
|
4,Correlation/Distribution,"correlation, distribution, scatter, relationship, pattern",Scatter Plot or Bubble Chart,"Heat Map, Matrix",Color axis: gradient (blue-red). Size: relative. Opacity: 0.6-0.8 to show density,⚠ Moderate (many points),⚠ Provide data table alternative. Use pattern + color distinction.,"D3.js, Plotly, Recharts",Hover + Brush
|
||||||
|
5,Heatmap/Intensity,"heatmap, heat-map, intensity, density, matrix",Heat Map or Choropleth,"Grid Heat Map, Bubble Heat",Gradient: Cool (blue) to Hot (red). Scale: clear legend. Divergent for ±data,⚡ Excellent (color CSS),⚠ Colorblind: Use pattern overlay. Provide numerical legend.,"D3.js, Plotly, ApexCharts",Hover + Zoom
|
||||||
|
6,Geographic Data,"geographic, map, location, region, geo, spatial","Choropleth Map, Bubble Map",Geographic Heat Map,Regional: single color gradient or categorized colors. Legend: clear scale,⚠ Moderate (rendering),⚠ Include text labels for regions. Provide data table alternative.,"D3.js, Mapbox, Leaflet",Pan + Zoom + Drill
|
||||||
|
7,Funnel/Flow,funnel/flow,"Funnel Chart, Sankey",Waterfall (for flows),Stages: gradient (starting color → ending color). Show conversion %,⚡ Good,✓ Clear stage labels + percentages. Good for accessibility if labeled.,"D3.js, Recharts, Custom SVG",Hover + Drill
|
||||||
|
8,Performance vs Target,performance-vs-target,Gauge Chart or Bullet Chart,"Dial, Thermometer",Performance: Red→Yellow→Green gradient. Target: marker line. Threshold colors,⚡ Good,✓ Add numerical value + percentage label beside gauge.,"D3.js, ApexCharts, Custom SVG",Hover
|
||||||
|
9,Time-Series Forecast,time-series-forecast,Line with Confidence Band,Ribbon Chart,Actual: solid line #0080FF. Forecast: dashed #FF9500. Band: light shading,⚡ Good,✓ Clearly distinguish actual vs forecast. Add legend.,"Chart.js, ApexCharts, Plotly",Hover + Toggle
|
||||||
|
10,Anomaly Detection,anomaly-detection,Line Chart with Highlights,Scatter with Alert,Normal: blue #0080FF. Anomaly: red #FF0000 circle/square marker + alert,⚡ Good,✓ Circle/marker for anomalies. Add text alert annotation.,"D3.js, Plotly, ApexCharts",Hover + Alert
|
||||||
|
11,Hierarchical/Nested Data,hierarchical/nested-data,Treemap,"Sunburst, Nested Donut, Icicle",Parent: distinct hues. Children: lighter shades. White borders 2-3px.,⚠ Moderate,⚠ Poor - provide table alternative. Label large areas.,"D3.js, Recharts, ApexCharts",Hover + Drilldown
|
||||||
|
12,Flow/Process Data,flow/process-data,Sankey Diagram,"Alluvial, Chord Diagram",Gradient from source to target. Opacity 0.4-0.6 for flows.,⚠ Moderate,⚠ Poor - provide flow table alternative.,"D3.js (d3-sankey), Plotly",Hover + Drilldown
|
||||||
|
13,Cumulative Changes,cumulative-changes,Waterfall Chart,"Stacked Bar, Cascade",Increases: #4CAF50. Decreases: #F44336. Start: #2196F3. End: #0D47A1.,⚡ Good,✓ Good - clear directional colors with labels.,"ApexCharts, Highcharts, Plotly",Hover
|
||||||
|
14,Multi-Variable Comparison,multi-variable-comparison,Radar/Spider Chart,"Parallel Coordinates, Grouped Bar",Single: #0080FF 20% fill. Multiple: distinct colors per dataset.,⚡ Good,⚠ Moderate - limit 5-8 axes. Add data table.,"Chart.js, Recharts, ApexCharts",Hover + Toggle
|
||||||
|
15,Stock/Trading OHLC,stock/trading-ohlc,Candlestick Chart,"OHLC Bar, Heikin-Ashi",Bullish: #26A69A. Bearish: #EF5350. Volume: 40% opacity below.,⚡ Good,⚠ Moderate - provide OHLC data table.,"Lightweight Charts (TradingView), ApexCharts",Real-time + Hover + Zoom
|
||||||
|
16,Relationship/Connection Data,relationship/connection-data,Network Graph,"Hierarchical Tree, Adjacency Matrix",Node types: categorical colors. Edges: #90A4AE 60% opacity.,❌ Poor (500+ nodes struggles),❌ Very Poor - provide adjacency list alternative.,"D3.js (d3-force), Vis.js, Cytoscape.js",Drilldown + Hover + Drag
|
||||||
|
17,Distribution/Statistical,distribution/statistical,Box Plot,"Violin Plot, Beeswarm",Box: #BBDEFB. Border: #1976D2. Median: #D32F2F. Outliers: #F44336.,⚡ Excellent,"✓ Good - include stats table (min, Q1, median, Q3, max).","Plotly, D3.js, Chart.js (plugin)",Hover
|
||||||
|
18,Performance vs Target (Compact),performance-vs-target-(compact),Bullet Chart,"Gauge, Progress Bar","Ranges: #FFCDD2, #FFF9C4, #C8E6C9. Performance: #1976D2. Target: black 3px.",⚡ Excellent,✓ Excellent - compact with clear values.,"D3.js, Plotly, Custom SVG",Hover
|
||||||
|
19,Proportional/Percentage,proportional/percentage,Waffle Chart,"Pictogram, Stacked Bar 100%",10x10 grid. 3-5 categories max. 2-3px spacing between squares.,⚡ Good,✓ Good - better than pie for accessibility.,"D3.js, React-Waffle, Custom CSS Grid",Hover
|
||||||
|
20,Hierarchical Proportional,hierarchical-proportional,Sunburst Chart,"Treemap, Icicle, Circle Packing",Center to outer: darker to lighter. 15-20% lighter per level.,⚠ Moderate,⚠ Poor - provide hierarchy table alternative.,"D3.js (d3-hierarchy), Recharts, ApexCharts",Drilldown + Hover
|
||||||
|
21,Root Cause Analysis,"root cause, decomposition, tree, hierarchy, drill-down, ai-split",Decomposition Tree,"Decision Tree, Flow Chart",Nodes: #2563EB (Primary) vs #EF4444 (Negative impact). Connectors: Neutral grey.,⚠ Moderate (calculation heavy),✓ clear hierarchy. Allow keyboard navigation for nodes.,"Power BI (native), React-Flow, Custom D3.js",Drill + Expand
|
||||||
|
22,3D Spatial Data,"3d, spatial, immersive, terrain, molecular, volumetric",3D Scatter/Surface Plot,"Volumetric Rendering, Point Cloud",Depth cues: lighting/shading. Z-axis: color gradient (cool to warm).,❌ Heavy (WebGL required),❌ Poor - requires alternative 2D view or data table.,"Three.js, Deck.gl, Plotly 3D",Rotate + Zoom + VR
|
||||||
|
23,Real-Time Streaming,"streaming, real-time, ticker, live, velocity, pulse",Streaming Area Chart,"Ticker Tape, Moving Gauge",Current: Bright Pulse (#00FF00). History: Fading opacity. Grid: Dark.,⚡ Optimized (canvas/webgl),⚠ Flashing elements - provide pause button. High contrast.,Smoothed D3.js, CanvasJS, SciChart,Real-time + Pause
|
||||||
|
24,Sentiment/Emotion,"sentiment, emotion, nlp, opinion, feeling",Word Cloud with Sentiment,"Sentiment Arc, Radar Chart",Positive: #22C55E. Negative: #EF4444. Neutral: #94A3B8. Size = Frequency.,⚡ Good,⚠ Word clouds poor for screen readers. Use list view.,"D3-cloud, Highcharts, Nivo",Hover + Filter
|
||||||
|
25,Process Mining,"process, mining, variants, path, bottleneck, log",Process Map / Graph,"Directed Acyclic Graph (DAG), Petri Net",Happy path: #10B981 (Thick). Deviations: #F59E0B (Thin). Bottlenecks: #EF4444.,⚠ Moderate to Heavy,⚠ Complex graphs hard to navigate. Provide path summary.,"React-Flow, Cytoscape.js, Recharts",Drag + Node-Click
|
||||||
|
Can't render this file because it has a wrong number of fields in line 24.
|
97
.claude/skills/ui-ux-pro-max/data/colors.csv
Normal file
97
.claude/skills/ui-ux-pro-max/data/colors.csv
Normal file
@ -0,0 +1,97 @@
|
|||||||
|
No,Product Type,Keywords,Primary (Hex),Secondary (Hex),CTA (Hex),Background (Hex),Text (Hex),Border (Hex),Notes
|
||||||
|
1,SaaS (General),"saas, general",#2563EB,#3B82F6,#F97316,#F8FAFC,#1E293B,#E2E8F0,Trust blue + accent contrast
|
||||||
|
2,Micro SaaS,"micro, saas",#2563EB,#3B82F6,#F97316,#F8FAFC,#1E293B,#E2E8F0,Vibrant primary + white space
|
||||||
|
3,E-commerce,commerce,#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand primary + success green
|
||||||
|
4,E-commerce Luxury,"commerce, luxury",#1C1917,#44403C,#CA8A04,#FAFAF9,#0C0A09,#D6D3D1,Premium colors + minimal accent
|
||||||
|
5,Service Landing Page,"service, landing, page",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand primary + trust colors
|
||||||
|
6,B2B Service,"b2b, service",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional blue + neutral grey
|
||||||
|
7,Financial Dashboard,"financial, dashboard",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark bg + red/green alerts + trust blue
|
||||||
|
8,Analytics Dashboard,"analytics, dashboard",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Cool→Hot gradients + neutral grey
|
||||||
|
9,Healthcare App,"healthcare, app",#0891B2,#22D3EE,#059669,#ECFEFF,#164E63,#A5F3FC,Calm blue + health green + trust
|
||||||
|
10,Educational App,"educational, app",#4F46E5,#818CF8,#F97316,#EEF2FF,#1E1B4B,#C7D2FE,Playful colors + clear hierarchy
|
||||||
|
11,Creative Agency,"creative, agency",#EC4899,#F472B6,#06B6D4,#FDF2F8,#831843,#FBCFE8,Bold primaries + artistic freedom
|
||||||
|
12,Portfolio/Personal,"portfolio, personal",#18181B,#3F3F46,#2563EB,#FAFAFA,#09090B,#E4E4E7,Brand primary + artistic interpretation
|
||||||
|
13,Gaming,gaming,#7C3AED,#A78BFA,#F43F5E,#0F0F23,#E2E8F0,#4C1D95,Vibrant + neon + immersive colors
|
||||||
|
14,Government/Public Service,"government, public, service",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional blue + high contrast
|
||||||
|
15,Fintech/Crypto,"fintech, crypto",#F59E0B,#FBBF24,#8B5CF6,#0F172A,#F8FAFC,#334155,Dark tech colors + trust + vibrant accents
|
||||||
|
16,Social Media App,"social, media, app",#2563EB,#60A5FA,#F43F5E,#F8FAFC,#1E293B,#DBEAFE,Vibrant + engagement colors
|
||||||
|
17,Productivity Tool,"productivity, tool",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Clear hierarchy + functional colors
|
||||||
|
18,Design System/Component Library,"design, system, component, library",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Clear hierarchy + code-like structure
|
||||||
|
19,AI/Chatbot Platform,"chatbot, platform",#7C3AED,#A78BFA,#06B6D4,#FAF5FF,#1E1B4B,#DDD6FE,Neutral + AI Purple (#6366F1)
|
||||||
|
20,NFT/Web3 Platform,"nft, web3, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark + Neon + Gold (#FFD700)
|
||||||
|
21,Creator Economy Platform,"creator, economy, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Vibrant + Brand colors
|
||||||
|
22,Sustainability/ESG Platform,"sustainability, esg, platform",#7C3AED,#A78BFA,#06B6D4,#FAF5FF,#1E1B4B,#DDD6FE,Green (#228B22) + Earth tones
|
||||||
|
23,Remote Work/Collaboration Tool,"remote, work, collaboration, tool",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Calm Blue + Neutral grey
|
||||||
|
24,Mental Health App,"mental, health, app",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Calm Pastels + Trust colors
|
||||||
|
25,Pet Tech App,"pet, tech, app",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Playful + Warm colors
|
||||||
|
26,Smart Home/IoT Dashboard,"smart, home, iot, dashboard",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark + Status indicator colors
|
||||||
|
27,EV/Charging Ecosystem,"charging, ecosystem",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Electric Blue (#009CD1) + Green
|
||||||
|
28,Subscription Box Service,"subscription, box, service",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand + Excitement colors
|
||||||
|
29,Podcast Platform,"podcast, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark + Audio waveform accents
|
||||||
|
30,Dating App,"dating, app",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Warm + Romantic (Pink/Red gradients)
|
||||||
|
31,Micro-Credentials/Badges Platform,"micro, credentials, badges, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Trust Blue + Gold (#FFD700)
|
||||||
|
32,Knowledge Base/Documentation,"knowledge, base, documentation",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Clean hierarchy + minimal color
|
||||||
|
33,Hyperlocal Services,"hyperlocal, services",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Location markers + Trust colors
|
||||||
|
34,Beauty/Spa/Wellness Service,"beauty, spa, wellness, service",#10B981,#34D399,#8B5CF6,#ECFDF5,#064E3B,#A7F3D0,Soft pastels (Pink #FFB6C1 Sage #90EE90) + Cream + Gold accents
|
||||||
|
35,Luxury/Premium Brand,"luxury, premium, brand",#1C1917,#44403C,#CA8A04,#FAFAF9,#0C0A09,#D6D3D1,Black + Gold (#FFD700) + White + Minimal accent
|
||||||
|
36,Restaurant/Food Service,"restaurant, food, service",#DC2626,#F87171,#CA8A04,#FEF2F2,#450A0A,#FECACA,Warm colors (Orange Red Brown) + appetizing imagery
|
||||||
|
37,Fitness/Gym App,"fitness, gym, app",#DC2626,#F87171,#16A34A,#FEF2F2,#1F2937,#FECACA,Energetic (Orange #FF6B35 Electric Blue) + Dark bg
|
||||||
|
38,Real Estate/Property,"real, estate, property",#0F766E,#14B8A6,#0369A1,#F0FDFA,#134E4A,#99F6E4,Trust Blue (#0077B6) + Gold accents + White
|
||||||
|
39,Travel/Tourism Agency,"travel, tourism, agency",#EC4899,#F472B6,#06B6D4,#FDF2F8,#831843,#FBCFE8,Vibrant destination colors + Sky Blue + Warm accents
|
||||||
|
40,Hotel/Hospitality,"hotel, hospitality",#1E3A8A,#3B82F6,#CA8A04,#F8FAFC,#1E40AF,#BFDBFE,Warm neutrals + Gold (#D4AF37) + Brand accent
|
||||||
|
41,Wedding/Event Planning,"wedding, event, planning",#7C3AED,#A78BFA,#F97316,#FAF5FF,#4C1D95,#DDD6FE,Soft Pink (#FFD6E0) + Gold + Cream + Sage
|
||||||
|
42,Legal Services,"legal, services",#1E3A8A,#1E40AF,#B45309,#F8FAFC,#0F172A,#CBD5E1,Navy Blue (#1E3A5F) + Gold + White
|
||||||
|
43,Insurance Platform,"insurance, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Trust Blue (#0066CC) + Green (security) + Neutral
|
||||||
|
44,Banking/Traditional Finance,"banking, traditional, finance",#0F766E,#14B8A6,#0369A1,#F0FDFA,#134E4A,#99F6E4,Navy (#0A1628) + Trust Blue + Gold accents
|
||||||
|
45,Online Course/E-learning,"online, course, learning",#0D9488,#2DD4BF,#EA580C,#F0FDFA,#134E4A,#5EEAD4,Vibrant learning colors + Progress green
|
||||||
|
46,Non-profit/Charity,"non, profit, charity",#0891B2,#22D3EE,#F97316,#ECFEFF,#164E63,#A5F3FC,Cause-related colors + Trust + Warm
|
||||||
|
47,Music Streaming,"music, streaming",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark (#121212) + Vibrant accents + Album art colors
|
||||||
|
48,Video Streaming/OTT,"video, streaming, ott",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark bg + Content poster colors + Brand accent
|
||||||
|
49,Job Board/Recruitment,"job, board, recruitment",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional Blue + Success Green + Neutral
|
||||||
|
50,Marketplace (P2P),"marketplace, p2p",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Trust colors + Category colors + Success green
|
||||||
|
51,Logistics/Delivery,"logistics, delivery",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Blue (#2563EB) + Orange (tracking) + Green (delivered)
|
||||||
|
52,Agriculture/Farm Tech,"agriculture, farm, tech",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Earth Green (#4A7C23) + Brown + Sky Blue
|
||||||
|
53,Construction/Architecture,"construction, architecture",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Grey (#4A4A4A) + Orange (safety) + Blueprint Blue
|
||||||
|
54,Automotive/Car Dealership,"automotive, car, dealership",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand colors + Metallic accents + Dark/Light
|
||||||
|
55,Photography Studio,"photography, studio",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Black + White + Minimal accent
|
||||||
|
56,Coworking Space,"coworking, space",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Energetic colors + Wood tones + Brand accent
|
||||||
|
57,Cleaning Service,"cleaning, service",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Fresh Blue (#00B4D8) + Clean White + Green
|
||||||
|
58,Home Services (Plumber/Electrician),"home, services, plumber, electrician",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Trust Blue + Safety Orange + Professional grey
|
||||||
|
59,Childcare/Daycare,"childcare, daycare",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Playful pastels + Safe colors + Warm accents
|
||||||
|
60,Senior Care/Elderly,"senior, care, elderly",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Calm Blue + Warm neutrals + Large text
|
||||||
|
61,Medical Clinic,"medical, clinic",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Medical Blue (#0077B6) + Trust White + Calm Green
|
||||||
|
62,Pharmacy/Drug Store,"pharmacy, drug, store",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Pharmacy Green + Trust Blue + Clean White
|
||||||
|
63,Dental Practice,"dental, practice",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Fresh Blue + White + Smile Yellow accent
|
||||||
|
64,Veterinary Clinic,"veterinary, clinic",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Caring Blue + Pet-friendly colors + Warm accents
|
||||||
|
65,Florist/Plant Shop,"florist, plant, shop",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Natural Green + Floral pinks/purples + Earth tones
|
||||||
|
66,Bakery/Cafe,"bakery, cafe",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Warm Brown + Cream + Appetizing accents
|
||||||
|
67,Coffee Shop,"coffee, shop",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Coffee Brown (#6F4E37) + Cream + Warm accents
|
||||||
|
68,Brewery/Winery,"brewery, winery",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Deep amber/burgundy + Gold + Craft aesthetic
|
||||||
|
69,Airline,airline,#7C3AED,#A78BFA,#06B6D4,#FAF5FF,#1E1B4B,#DDD6FE,Sky Blue + Brand colors + Trust accents
|
||||||
|
70,News/Media Platform,"news, media, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand colors + High contrast + Category colors
|
||||||
|
71,Magazine/Blog,"magazine, blog",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Editorial colors + Brand primary + Clean white
|
||||||
|
72,Freelancer Platform,"freelancer, platform",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional Blue + Success Green + Neutral
|
||||||
|
73,Consulting Firm,"consulting, firm",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Navy + Gold + Professional grey
|
||||||
|
74,Marketing Agency,"marketing, agency",#EC4899,#F472B6,#06B6D4,#FDF2F8,#831843,#FBCFE8,Bold brand colors + Creative freedom
|
||||||
|
75,Event Management,"event, management",#7C3AED,#A78BFA,#F97316,#FAF5FF,#4C1D95,#DDD6FE,Event theme colors + Excitement accents
|
||||||
|
76,Conference/Webinar Platform,"conference, webinar, platform",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional Blue + Video accent + Brand
|
||||||
|
77,Membership/Community,"membership, community",#7C3AED,#A78BFA,#F97316,#FAF5FF,#4C1D95,#DDD6FE,Community brand colors + Engagement accents
|
||||||
|
78,Newsletter Platform,"newsletter, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand primary + Clean white + CTA accent
|
||||||
|
79,Digital Products/Downloads,"digital, products, downloads",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Product category colors + Brand + Success green
|
||||||
|
80,Church/Religious Organization,"church, religious, organization",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Warm Gold + Deep Purple/Blue + White
|
||||||
|
81,Sports Team/Club,"sports, team, club",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Team colors + Energetic accents
|
||||||
|
82,Museum/Gallery,"museum, gallery",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Art-appropriate neutrals + Exhibition accents
|
||||||
|
83,Theater/Cinema,"theater, cinema",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark + Spotlight accents + Gold
|
||||||
|
84,Language Learning App,"language, learning, app",#0D9488,#2DD4BF,#EA580C,#F0FDFA,#134E4A,#5EEAD4,Playful colors + Progress indicators + Country flags
|
||||||
|
85,Coding Bootcamp,"coding, bootcamp",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Code editor colors + Brand + Success green
|
||||||
|
86,Cybersecurity Platform,"cybersecurity, security, cyber, hacker",#00FF41,#0D0D0D,#00FF41,#000000,#E0E0E0,#1F1F1F,Matrix Green + Deep Black + Terminal feel
|
||||||
|
87,Developer Tool / IDE,"developer, tool, ide, code, dev",#3B82F6,#1E293B,#2563EB,#0F172A,#F1F5F9,#334155,Dark syntax theme colors + Blue focus
|
||||||
|
88,Biotech / Life Sciences,"biotech, science, biology, medical",#0EA5E9,#0284C7,#10B981,#F8FAFC,#0F172A,#E2E8F0,Sterile White + DNA Blue + Life Green
|
||||||
|
89,Space Tech / Aerospace,"space, aerospace, tech, futuristic",#FFFFFF,#94A3B8,#3B82F6,#0B0B10,#F8FAFC,#1E293B,Deep Space Black + Star White + Metallic
|
||||||
|
90,Architecture / Interior,"architecture, interior, design, luxury",#171717,#404040,#D4AF37,#FFFFFF,#171717,#E5E5E5,Monochrome + Gold Accent + High Imagery
|
||||||
|
91,Quantum Computing,"quantum, qubit, tech",#00FFFF,#7B61FF,#FF00FF,#050510,#E0E0FF,#333344,Interference patterns + Neon + Deep Dark
|
||||||
|
92,Biohacking / Longevity,"bio, health, science",#FF4D4D,#4D94FF,#00E676,#F5F5F7,#1C1C1E,#E5E5EA,Biological red/blue + Clinical white
|
||||||
|
93,Autonomous Systems,"drone, robot, fleet",#00FF41,#008F11,#FF3333,#0D1117,#E6EDF3,#30363D,Terminal Green + Tactical Dark
|
||||||
|
94,Generative AI Art,"art, gen-ai, creative",#111111,#333333,#FFFFFF,#FAFAFA,#000000,#E5E5E5,Canvas Neutral + High Contrast
|
||||||
|
95,Spatial / Vision OS,"spatial, glass, vision",#FFFFFF,#E5E5E5,#007AFF,#888888,#000000,#FFFFFF,Glass opacity 20% + System Blue
|
||||||
|
96,Climate Tech,"climate, green, energy",#2E8B57,#87CEEB,#FFD700,#F0FFF4,#1A3320,#C6E6C6,Nature Green + Solar Yellow + Air Blue
|
||||||
|
31
.claude/skills/ui-ux-pro-max/data/landing.csv
Normal file
31
.claude/skills/ui-ux-pro-max/data/landing.csv
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
No,Pattern Name,Keywords,Section Order,Primary CTA Placement,Color Strategy,Recommended Effects,Conversion Optimization
|
||||||
|
1,Hero + Features + CTA,"hero, hero-centric, features, feature-rich, cta, call-to-action","1. Hero with headline/image, 2. Value prop, 3. Key features (3-5), 4. CTA section, 5. Footer",Hero (sticky) + Bottom,Hero: Brand primary or vibrant. Features: Card bg #FAFAFA. CTA: Contrasting accent color,"Hero parallax, feature card hover lift, CTA glow on hover",Deep CTA placement. Use contrasting color (at least 7:1 contrast ratio). Sticky navbar CTA.
|
||||||
|
2,Hero + Testimonials + CTA,"hero, testimonials, social-proof, trust, reviews, cta","1. Hero, 2. Problem statement, 3. Solution overview, 4. Testimonials carousel, 5. CTA",Hero (sticky) + Post-testimonials,"Hero: Brand color. Testimonials: Light bg #F5F5F5. Quotes: Italic, muted color #666. CTA: Vibrant","Testimonial carousel slide animations, quote marks animations, avatar fade-in",Social proof before CTA. Use 3-5 testimonials. Include photo + name + role. CTA after social proof.
|
||||||
|
3,Product Demo + Features,"demo, product-demo, features, showcase, interactive","1. Hero, 2. Product video/mockup (center), 3. Feature breakdown per section, 4. Comparison (optional), 5. CTA",Video center + CTA right/bottom,Video surround: Brand color overlay. Features: Icon color #0080FF. Text: Dark #222,"Video play button pulse, feature scroll reveals, demo interaction highlights",Embedded product demo increases engagement. Use interactive mockup if possible. Auto-play video muted.
|
||||||
|
4,Minimal Single Column,"minimal, simple, direct, single-column, clean","1. Hero headline, 2. Short description, 3. Benefit bullets (3 max), 4. CTA, 5. Footer","Center, large CTA button",Minimalist: Brand + white #FFFFFF + accent. Buttons: High contrast 7:1+. Text: Black/Dark grey,Minimal hover effects. Smooth scroll. CTA scale on hover (subtle),Single CTA focus. Large typography. Lots of whitespace. No nav clutter. Mobile-first.
|
||||||
|
5,Funnel (3-Step Conversion),"funnel, conversion, steps, wizard, onboarding","1. Hero, 2. Step 1 (problem), 3. Step 2 (solution), 4. Step 3 (action), 5. CTA progression",Each step: mini-CTA. Final: main CTA,"Step colors: 1 (Red/Problem), 2 (Orange/Process), 3 (Green/Solution). CTA: Brand color","Step number animations, progress bar fill, step transitions smooth scroll",Progressive disclosure. Show only essential info per step. Use progress indicators. Multiple CTAs.
|
||||||
|
6,Comparison Table + CTA,"comparison, table, compare, versus, cta","1. Hero, 2. Problem intro, 3. Comparison table (product vs competitors), 4. Pricing (optional), 5. CTA",Table: Right column. CTA: Below table,Table: Alternating rows (white/light grey). Your product: Highlight #FFFACD (light yellow) or green. Text: Dark,"Table row hover highlight, price toggle animations, feature checkmark animations",Use comparison to show unique value. Highlight your product row. Include 'free trial' in pricing row.
|
||||||
|
7,Lead Magnet + Form,"lead, form, signup, capture, email, magnet","1. Hero (benefit headline), 2. Lead magnet preview (ebook cover, checklist, etc), 3. Form (minimal fields), 4. CTA submit",Form CTA: Submit button,Lead magnet: Professional design. Form: Clean white bg. Inputs: Light border #CCCCCC. CTA: Brand color,"Form focus state animations, input validation animations, success confirmation animation",Form fields ≤ 3 for best conversion. Offer valuable lead magnet preview. Show form submission progress.
|
||||||
|
8,Pricing Page + CTA,"pricing, plans, tiers, comparison, cta","1. Hero (pricing headline), 2. Price comparison cards, 3. Feature comparison table, 4. FAQ section, 5. Final CTA",Each card: CTA button. Sticky CTA in nav,"Free: Grey, Starter: Blue, Pro: Green/Gold, Enterprise: Dark. Cards: 1px border, shadow","Price toggle animation (monthly/yearly), card comparison highlight, FAQ accordion open/close",Recommend starter plan (pre-select/highlight). Show annual discount (20-30%). Use FAQs to address concerns.
|
||||||
|
9,Video-First Hero,"video, hero, media, visual, engaging","1. Hero with video background, 2. Key features overlay, 3. Benefits section, 4. CTA",Overlay on video (center/bottom) + Bottom section,Dark overlay 60% on video. Brand accent for CTA. White text on dark.,"Video autoplay muted, parallax scroll, text fade-in on scroll",86% higher engagement with video. Add captions for accessibility. Compress video for performance.
|
||||||
|
10,Scroll-Triggered Storytelling,"storytelling, scroll, narrative, story, immersive","1. Intro hook, 2. Chapter 1 (problem), 3. Chapter 2 (journey), 4. Chapter 3 (solution), 5. Climax CTA",End of each chapter (mini) + Final climax CTA,Progressive reveal. Each chapter has distinct color. Building intensity.,"ScrollTrigger animations, parallax layers, progressive disclosure, chapter transitions",Narrative increases time-on-page 3x. Use progress indicator. Mobile: simplify animations.
|
||||||
|
11,AI Personalization Landing,"ai, personalization, smart, recommendation, dynamic","1. Dynamic hero (personalized), 2. Relevant features, 3. Tailored testimonials, 4. Smart CTA",Context-aware placement based on user segment,Adaptive based on user data. A/B test color variations per segment.,"Dynamic content swap, fade transitions, personalized product recommendations",20%+ conversion with personalization. Requires analytics integration. Fallback for new users.
|
||||||
|
12,Waitlist/Coming Soon,"waitlist, coming-soon, launch, early-access, notify","1. Hero with countdown, 2. Product teaser/preview, 3. Email capture form, 4. Social proof (waitlist count)",Email form prominent (above fold) + Sticky form on scroll,Anticipation: Dark + accent highlights. Countdown in brand color. Urgency indicators.,"Countdown timer animation, email validation feedback, success confetti, social share buttons",Scarcity + exclusivity. Show waitlist count. Early access benefits. Referral program.
|
||||||
|
13,Comparison Table Focus,"comparison, table, versus, compare, features","1. Hero (problem statement), 2. Comparison matrix (you vs competitors), 3. Feature deep-dive, 4. Winner CTA",After comparison table (highlighted row) + Bottom,Your product column highlighted (accent bg or green). Competitors neutral. Checkmarks green.,"Table row hover highlight, feature checkmark animations, sticky comparison header",Show value vs competitors. 35% higher conversion. Be factual. Include pricing if favorable.
|
||||||
|
14,Pricing-Focused Landing,"pricing, price, cost, plans, subscription","1. Hero (value proposition), 2. Pricing cards (3 tiers), 3. Feature comparison, 4. FAQ, 5. Final CTA",Each pricing card + Sticky CTA in nav + Bottom,Popular plan highlighted (brand color border/bg). Free: grey. Enterprise: dark/premium.,"Price toggle monthly/annual animation, card hover lift, FAQ accordion smooth open",Annual discount 20-30%. Recommend mid-tier (most popular badge). Address objections in FAQ.
|
||||||
|
15,App Store Style Landing,"app, mobile, download, store, install","1. Hero with device mockup, 2. Screenshots carousel, 3. Features with icons, 4. Reviews/ratings, 5. Download CTAs",Download buttons prominent (App Store + Play Store) throughout,Dark/light matching app store feel. Star ratings in gold. Screenshots with device frames.,"Device mockup rotations, screenshot slider, star rating animations, download button pulse",Show real screenshots. Include ratings (4.5+ stars). QR code for mobile. Platform-specific CTAs.
|
||||||
|
16,FAQ/Documentation Landing,"faq, documentation, help, support, questions","1. Hero with search bar, 2. Popular categories, 3. FAQ accordion, 4. Contact/support CTA",Search bar prominent + Contact CTA for unresolved questions,"Clean, high readability. Minimal color. Category icons in brand color. Success green for resolved.","Search autocomplete, smooth accordion open/close, category hover, helpful feedback buttons",Reduce support tickets. Track search analytics. Show related articles. Contact escalation path.
|
||||||
|
17,Immersive/Interactive Experience,"immersive, interactive, experience, 3d, animation","1. Full-screen interactive element, 2. Guided product tour, 3. Key benefits revealed, 4. CTA after completion",After interaction complete + Skip option for impatient users,Immersive experience colors. Dark background for focus. Highlight interactive elements.,"WebGL, 3D interactions, gamification elements, progress indicators, reward animations",40% higher engagement. Performance trade-off. Provide skip option. Mobile fallback essential.
|
||||||
|
18,Event/Conference Landing,"event, conference, meetup, registration, schedule","1. Hero (date/location/countdown), 2. Speakers grid, 3. Agenda/schedule, 4. Sponsors, 5. Register CTA",Register CTA sticky + After speakers + Bottom,Urgency colors (countdown). Event branding. Speaker cards professional. Sponsor logos neutral.,"Countdown timer, speaker hover cards with bio, agenda tabs, early bird countdown",Early bird pricing with deadline. Social proof (past attendees). Speaker credibility. Multi-ticket discounts.
|
||||||
|
19,Product Review/Ratings Focused,"reviews, ratings, testimonials, social-proof, stars","1. Hero (product + aggregate rating), 2. Rating breakdown, 3. Individual reviews, 4. Buy/CTA",After reviews summary + Buy button alongside reviews,Trust colors. Star ratings gold. Verified badge green. Review sentiment colors.,"Star fill animations, review filtering, helpful vote interactions, photo lightbox",User-generated content builds trust. Show verified purchases. Filter by rating. Respond to negative reviews.
|
||||||
|
20,Community/Forum Landing,"community, forum, social, members, discussion","1. Hero (community value prop), 2. Popular topics/categories, 3. Active members showcase, 4. Join CTA",Join button prominent + After member showcase,"Warm, welcoming. Member photos add humanity. Topic badges in brand colors. Activity indicators green.","Member avatars animation, activity feed live updates, topic hover previews, join success celebration","Show active community (member count, posts today). Highlight benefits. Preview content. Easy onboarding."
|
||||||
|
21,Before-After Transformation,"before-after, transformation, results, comparison","1. Hero (problem state), 2. Transformation slider/comparison, 3. How it works, 4. Results CTA",After transformation reveal + Bottom,Contrast: muted/grey (before) vs vibrant/colorful (after). Success green for results.,"Slider comparison interaction, before/after reveal animations, result counters, testimonial videos",Visual proof of value. 45% higher conversion. Real results. Specific metrics. Guarantee offer.
|
||||||
|
22,Marketplace / Directory,"marketplace, directory, search, listing","1. Hero (Search focused), 2. Categories, 3. Featured Listings, 4. Trust/Safety, 5. CTA (Become a host/seller)",Hero Search Bar + Navbar 'List your item',Search: High contrast. Categories: Visual icons. Trust: Blue/Green.,Search autocomplete animation, map hover pins, card carousel,Search bar is the CTA. Reduce friction to search. Popular searches suggestions.
|
||||||
|
23,Newsletter / Content First,"newsletter, content, writer, blog, subscribe","1. Hero (Value Prop + Form), 2. Recent Issues/Archives, 3. Social Proof (Subscriber count), 4. About Author",Hero inline form + Sticky header form,Minimalist. Paper-like background. Text focus. Accent color for Subscribe.,Text highlight animations, typewriter effect, subtle fade-in,Single field form (Email only). Show 'Join X,000 readers'. Read sample link.
|
||||||
|
24,Webinar Registration,"webinar, registration, event, training, live","1. Hero (Topic + Timer + Form), 2. What you'll learn, 3. Speaker Bio, 4. Urgency/Bonuses, 5. Form (again)",Hero (Right side form) + Bottom anchor,Urgency: Red/Orange. Professional: Blue/Navy. Form: High contrast white.,Countdown timer, speaker avatar float, urgent ticker,Limited seats logic. 'Live' indicator. Auto-fill timezone.
|
||||||
|
25,Enterprise Gateway,"enterprise, corporate, gateway, solutions, portal","1. Hero (Video/Mission), 2. Solutions by Industry, 3. Solutions by Role, 4. Client Logos, 5. Contact Sales",Contact Sales (Primary) + Login (Secondary),Corporate: Navy/Grey. High integrity. Conservative accents.,Slow video background, logo carousel, tab switching for industries,Path selection (I am a...). Mega menu navigation. Trust signals prominent.
|
||||||
|
26,Portfolio Grid,"portfolio, grid, showcase, gallery, masonry","1. Hero (Name/Role), 2. Project Grid (Masonry), 3. About/Philosophy, 4. Contact",Project Card Hover + Footer Contact,Neutral background (let work shine). Text: Black/White. Accent: Minimal.,Image lazy load reveal, hover overlay info, lightbox view,Visuals first. Filter by category. Fast loading essential.
|
||||||
|
27,Horizontal Scroll Journey,"horizontal, scroll, journey, gallery, storytelling, panoramic","1. Intro (Vertical), 2. The Journey (Horizontal Track), 3. Detail Reveal, 4. Vertical Footer","Floating Sticky CTA or End of Horizontal Track","Continuous palette transition. Chapter colors. Progress bar #000000.","Scroll-jacking (careful), parallax layers, horizontal slide, progress indicator","Immersive product discovery. High engagement. Keep navigation visible.
|
||||||
|
28,Bento Grid Showcase,"bento, grid, features, modular, apple-style, showcase","1. Hero, 2. Bento Grid (Key Features), 3. Detail Cards, 4. Tech Specs, 5. CTA","Floating Action Button or Bottom of Grid","Card backgrounds: #F5F5F7 or Glass. Icons: Vibrant brand colors. Text: Dark.","Hover card scale (1.02), video inside cards, tilt effect, staggered reveal","Scannable value props. High information density without clutter. Mobile stack.
|
||||||
|
29,Interactive 3D Configurator,"3d, configurator, customizer, interactive, product","1. Hero (Configurator), 2. Feature Highlight (synced), 3. Price/Specs, 4. Purchase","Inside Configurator UI + Sticky Bottom Bar","Neutral studio background. Product: Realistic materials. UI: Minimal overlay.","Real-time rendering, material swap animation, camera rotate/zoom, light reflection","Increases ownership feeling. 360 view reduces return rates. Direct add-to-cart.
|
||||||
|
30,AI-Driven Dynamic Landing,"ai, dynamic, personalized, adaptive, generative","1. Prompt/Input Hero, 2. Generated Result Preview, 3. How it Works, 4. Value Prop","Input Field (Hero) + 'Try it' Buttons","Adaptive to user input. Dark mode for compute feel. Neon accents.","Typing text effects, shimmering generation loaders, morphing layouts","Immediate value demonstration. 'Show, don't tell'. Low friction start.
|
||||||
|
Can't render this file because it has a wrong number of fields in line 23.
|
97
.claude/skills/ui-ux-pro-max/data/products.csv
Normal file
97
.claude/skills/ui-ux-pro-max/data/products.csv
Normal file
@ -0,0 +1,97 @@
|
|||||||
|
No,Product Type,Keywords,Primary Style Recommendation,Secondary Styles,Landing Page Pattern,Dashboard Style (if applicable),Color Palette Focus,Key Considerations
|
||||||
|
1,SaaS (General),"app, b2b, cloud, general, saas, software, subscription",Glassmorphism + Flat Design,"Soft UI Evolution, Minimalism",Hero + Features + CTA,Data-Dense + Real-Time Monitoring,Trust blue + accent contrast,Balance modern feel with clarity. Focus on CTAs.
|
||||||
|
2,Micro SaaS,"app, b2b, cloud, indie, micro, micro-saas, niche, saas, small, software, solo, subscription",Flat Design + Vibrant & Block,"Motion-Driven, Micro-interactions",Minimal & Direct + Demo,Executive Dashboard,Vibrant primary + white space,"Keep simple, show product quickly. Speed is key."
|
||||||
|
3,E-commerce,"buy, commerce, e, ecommerce, products, retail, sell, shop, store",Vibrant & Block-based,"Aurora UI, Motion-Driven",Feature-Rich Showcase,Sales Intelligence Dashboard,Brand primary + success green,Engagement & conversions. High visual hierarchy.
|
||||||
|
4,E-commerce Luxury,"buy, commerce, e, ecommerce, elegant, exclusive, high-end, luxury, premium, products, retail, sell, shop, store",Liquid Glass + Glassmorphism,"3D & Hyperrealism, Aurora UI",Feature-Rich Showcase,Sales Intelligence Dashboard,Premium colors + minimal accent,Elegance & sophistication. Premium materials.
|
||||||
|
5,Service Landing Page,"appointment, booking, consultation, conversion, landing, marketing, page, service",Hero-Centric + Trust & Authority,"Social Proof-Focused, Storytelling",Hero-Centric Design,N/A - Analytics for conversions,Brand primary + trust colors,Social proof essential. Show expertise.
|
||||||
|
6,B2B Service,"appointment, b, b2b, booking, business, consultation, corporate, enterprise, service",Trust & Authority + Minimal,"Feature-Rich, Conversion-Optimized",Feature-Rich Showcase,Sales Intelligence Dashboard,Professional blue + neutral grey,Credibility essential. Clear ROI messaging.
|
||||||
|
7,Financial Dashboard,"admin, analytics, dashboard, data, financial, panel",Dark Mode (OLED) + Data-Dense,"Minimalism, Accessible & Ethical",N/A - Dashboard focused,Financial Dashboard,Dark bg + red/green alerts + trust blue,"High contrast, real-time updates, accuracy paramount."
|
||||||
|
8,Analytics Dashboard,"admin, analytics, dashboard, data, panel",Data-Dense + Heat Map & Heatmap,"Minimalism, Dark Mode (OLED)",N/A - Analytics focused,Drill-Down Analytics + Comparative,Cool→Hot gradients + neutral grey,Clarity > aesthetics. Color-coded data priority.
|
||||||
|
9,Healthcare App,"app, clinic, health, healthcare, medical, patient",Neumorphism + Accessible & Ethical,"Soft UI Evolution, Claymorphism (for patients)",Social Proof-Focused,User Behavior Analytics,Calm blue + health green + trust,Accessibility mandatory. Calming aesthetic.
|
||||||
|
10,Educational App,"app, course, education, educational, learning, school, training",Claymorphism + Micro-interactions,"Vibrant & Block-based, Flat Design",Storytelling-Driven,User Behavior Analytics,Playful colors + clear hierarchy,Engagement & ease of use. Age-appropriate design.
|
||||||
|
11,Creative Agency,"agency, creative, design, marketing, studio",Brutalism + Motion-Driven,"Retro-Futurism, Storytelling-Driven",Storytelling-Driven,N/A - Portfolio focused,Bold primaries + artistic freedom,Differentiation key. Wow-factor necessary.
|
||||||
|
12,Portfolio/Personal,"creative, personal, portfolio, projects, showcase, work",Motion-Driven + Minimalism,"Brutalism, Aurora UI",Storytelling-Driven,N/A - Personal branding,Brand primary + artistic interpretation,Showcase work. Personality shine through.
|
||||||
|
13,Gaming,"entertainment, esports, game, gaming, play",3D & Hyperrealism + Retro-Futurism,"Motion-Driven, Vibrant & Block",Feature-Rich Showcase,N/A - Game focused,Vibrant + neon + immersive colors,Immersion priority. Performance critical.
|
||||||
|
14,Government/Public Service,"appointment, booking, consultation, government, public, service",Accessible & Ethical + Minimalism,"Flat Design, Inclusive Design",Minimal & Direct,Executive Dashboard,Professional blue + high contrast,WCAG AAA mandatory. Trust paramount.
|
||||||
|
15,Fintech/Crypto,"banking, blockchain, crypto, defi, finance, fintech, money, nft, payment, web3",Glassmorphism + Dark Mode (OLED),"Retro-Futurism, Motion-Driven",Conversion-Optimized,Real-Time Monitoring + Predictive,Dark tech colors + trust + vibrant accents,Security perception. Real-time data critical.
|
||||||
|
16,Social Media App,"app, community, content, entertainment, media, network, sharing, social, streaming, users, video",Vibrant & Block-based + Motion-Driven,"Aurora UI, Micro-interactions",Feature-Rich Showcase,User Behavior Analytics,Vibrant + engagement colors,Engagement & retention. Addictive design ethics.
|
||||||
|
17,Productivity Tool,"collaboration, productivity, project, task, tool, workflow",Flat Design + Micro-interactions,"Minimalism, Soft UI Evolution",Interactive Product Demo,Drill-Down Analytics,Clear hierarchy + functional colors,Ease of use. Speed & efficiency focus.
|
||||||
|
18,Design System/Component Library,"component, design, library, system",Minimalism + Accessible & Ethical,"Flat Design, Zero Interface",Feature-Rich Showcase,N/A - Dev focused,Clear hierarchy + code-like structure,Consistency. Developer-first approach.
|
||||||
|
19,AI/Chatbot Platform,"ai, artificial-intelligence, automation, chatbot, machine-learning, ml, platform",AI-Native UI + Minimalism,"Zero Interface, Glassmorphism",Interactive Product Demo,AI/ML Analytics Dashboard,Neutral + AI Purple (#6366F1),Conversational UI. Streaming text. Context awareness. Minimal chrome.
|
||||||
|
20,NFT/Web3 Platform,"nft, platform, web",Cyberpunk UI + Glassmorphism,"Aurora UI, 3D & Hyperrealism",Feature-Rich Showcase,Crypto/Blockchain Dashboard,Dark + Neon + Gold (#FFD700),Wallet integration. Transaction feedback. Gas fees display. Dark mode essential.
|
||||||
|
21,Creator Economy Platform,"creator, economy, platform",Vibrant & Block-based + Bento Box Grid,"Motion-Driven, Aurora UI",Social Proof-Focused,User Behavior Analytics,Vibrant + Brand colors,Creator profiles. Monetization display. Engagement metrics. Social proof.
|
||||||
|
22,Sustainability/ESG Platform,"ai, artificial-intelligence, automation, esg, machine-learning, ml, platform, sustainability",Organic Biophilic + Minimalism,"Accessible & Ethical, Flat Design",Trust & Authority,Energy/Utilities Dashboard,Green (#228B22) + Earth tones,Carbon footprint visuals. Progress indicators. Certification badges. Eco-friendly imagery.
|
||||||
|
23,Remote Work/Collaboration Tool,"collaboration, remote, tool, work",Soft UI Evolution + Minimalism,"Glassmorphism, Micro-interactions",Feature-Rich Showcase,Drill-Down Analytics,Calm Blue + Neutral grey,Real-time collaboration. Status indicators. Video integration. Notification management.
|
||||||
|
24,Mental Health App,"app, health, mental",Neumorphism + Accessible & Ethical,"Claymorphism, Soft UI Evolution",Social Proof-Focused,Healthcare Analytics,Calm Pastels + Trust colors,Calming aesthetics. Privacy-first. Crisis resources. Progress tracking. Accessibility mandatory.
|
||||||
|
25,Pet Tech App,"app, pet, tech",Claymorphism + Vibrant & Block-based,"Micro-interactions, Flat Design",Storytelling-Driven,User Behavior Analytics,Playful + Warm colors,Pet profiles. Health tracking. Playful UI. Photo galleries. Vet integration.
|
||||||
|
26,Smart Home/IoT Dashboard,"admin, analytics, dashboard, data, home, iot, panel, smart",Glassmorphism + Dark Mode (OLED),"Minimalism, AI-Native UI",Interactive Product Demo,Real-Time Monitoring,Dark + Status indicator colors,Device status. Real-time controls. Energy monitoring. Automation rules. Quick actions.
|
||||||
|
27,EV/Charging Ecosystem,"charging, ecosystem, ev",Minimalism + Aurora UI,"Glassmorphism, Organic Biophilic",Hero-Centric Design,Energy/Utilities Dashboard,Electric Blue (#009CD1) + Green,Charging station maps. Range estimation. Cost calculation. Environmental impact.
|
||||||
|
28,Subscription Box Service,"appointment, booking, box, consultation, membership, plan, recurring, service, subscription",Vibrant & Block-based + Motion-Driven,"Claymorphism, Aurora UI",Feature-Rich Showcase,E-commerce Analytics,Brand + Excitement colors,Unboxing experience. Personalization quiz. Subscription management. Product reveals.
|
||||||
|
29,Podcast Platform,"platform, podcast",Dark Mode (OLED) + Minimalism,"Motion-Driven, Vibrant & Block-based",Storytelling-Driven,Media/Entertainment Dashboard,Dark + Audio waveform accents,Audio player UX. Episode discovery. Creator tools. Analytics for podcasters.
|
||||||
|
30,Dating App,"app, dating",Vibrant & Block-based + Motion-Driven,"Aurora UI, Glassmorphism",Social Proof-Focused,User Behavior Analytics,Warm + Romantic (Pink/Red gradients),Profile cards. Swipe interactions. Match animations. Safety features. Video chat.
|
||||||
|
31,Micro-Credentials/Badges Platform,"badges, credentials, micro, platform",Minimalism + Flat Design,"Accessible & Ethical, Swiss Modernism 2.0",Trust & Authority,Education Dashboard,Trust Blue + Gold (#FFD700),Credential verification. Badge display. Progress tracking. Issuer trust. LinkedIn integration.
|
||||||
|
32,Knowledge Base/Documentation,"base, documentation, knowledge",Minimalism + Accessible & Ethical,"Swiss Modernism 2.0, Flat Design",FAQ/Documentation,N/A - Documentation focused,Clean hierarchy + minimal color,Search-first. Clear navigation. Code highlighting. Version switching. Feedback system.
|
||||||
|
33,Hyperlocal Services,"appointment, booking, consultation, hyperlocal, service, services",Minimalism + Vibrant & Block-based,"Micro-interactions, Flat Design",Conversion-Optimized,Drill-Down Analytics + Map,Location markers + Trust colors,Map integration. Service categories. Provider profiles. Booking system. Reviews.
|
||||||
|
34,Beauty/Spa/Wellness Service,"appointment, beauty, booking, consultation, service, spa, wellness",Soft UI Evolution + Neumorphism,"Glassmorphism, Minimalism",Hero-Centric Design + Social Proof,User Behavior Analytics,Soft pastels (Pink #FFB6C1 Sage #90EE90) + Cream + Gold accents,Calming aesthetic. Booking system. Service menu. Before/after gallery. Testimonials. Relaxing imagery.
|
||||||
|
35,Luxury/Premium Brand,"brand, elegant, exclusive, high-end, luxury, premium",Liquid Glass + Glassmorphism,"Minimalism, 3D & Hyperrealism",Storytelling-Driven + Feature-Rich,Sales Intelligence Dashboard,Black + Gold (#FFD700) + White + Minimal accent,Elegance paramount. Premium imagery. Storytelling. High-quality visuals. Exclusive feel.
|
||||||
|
36,Restaurant/Food Service,"appointment, booking, consultation, delivery, food, menu, order, restaurant, service",Vibrant & Block-based + Motion-Driven,"Claymorphism, Flat Design",Hero-Centric Design + Conversion,N/A - Booking focused,Warm colors (Orange Red Brown) + appetizing imagery,Menu display. Online ordering. Reservation system. Food photography. Location/hours prominent.
|
||||||
|
37,Fitness/Gym App,"app, exercise, fitness, gym, health, workout",Vibrant & Block-based + Dark Mode (OLED),"Motion-Driven, Neumorphism",Feature-Rich Showcase,User Behavior Analytics,Energetic (Orange #FF6B35 Electric Blue) + Dark bg,Progress tracking. Workout plans. Community features. Achievements. Motivational design.
|
||||||
|
38,Real Estate/Property,"buy, estate, housing, property, real, real-estate, rent",Glassmorphism + Minimalism,"Motion-Driven, 3D & Hyperrealism",Hero-Centric Design + Feature-Rich,Sales Intelligence Dashboard,Trust Blue (#0077B6) + Gold accents + White,Property listings. Virtual tours. Map integration. Agent profiles. Mortgage calculator. High-quality imagery.
|
||||||
|
39,Travel/Tourism Agency,"agency, booking, creative, design, flight, hotel, marketing, studio, tourism, travel, vacation",Aurora UI + Motion-Driven,"Vibrant & Block-based, Glassmorphism",Storytelling-Driven + Hero-Centric,Booking Analytics,Vibrant destination colors + Sky Blue + Warm accents,Destination showcase. Booking system. Itinerary builder. Reviews. Inspiration galleries. Mobile-first.
|
||||||
|
40,Hotel/Hospitality,"hospitality, hotel",Liquid Glass + Minimalism,"Glassmorphism, Soft UI Evolution",Hero-Centric Design + Social Proof,Revenue Management Dashboard,Warm neutrals + Gold (#D4AF37) + Brand accent,Room booking. Amenities showcase. Location maps. Guest reviews. Seasonal pricing. Luxury imagery.
|
||||||
|
41,Wedding/Event Planning,"conference, event, meetup, planning, registration, ticket, wedding",Soft UI Evolution + Aurora UI,"Glassmorphism, Motion-Driven",Storytelling-Driven + Social Proof,N/A - Planning focused,Soft Pink (#FFD6E0) + Gold + Cream + Sage,Portfolio gallery. Vendor directory. Planning tools. Timeline. Budget tracker. Romantic aesthetic.
|
||||||
|
42,Legal Services,"appointment, attorney, booking, compliance, consultation, contract, law, legal, service, services",Trust & Authority + Minimalism,"Accessible & Ethical, Swiss Modernism 2.0",Trust & Authority + Minimal,Case Management Dashboard,Navy Blue (#1E3A5F) + Gold + White,Credibility paramount. Practice areas. Attorney profiles. Case results. Contact forms. Professional imagery.
|
||||||
|
43,Insurance Platform,"insurance, platform",Trust & Authority + Flat Design,"Accessible & Ethical, Minimalism",Conversion-Optimized + Trust,Claims Analytics Dashboard,Trust Blue (#0066CC) + Green (security) + Neutral,Quote calculator. Policy comparison. Claims process. Trust signals. Clear pricing. Security badges.
|
||||||
|
44,Banking/Traditional Finance,"banking, finance, traditional",Minimalism + Accessible & Ethical,"Trust & Authority, Dark Mode (OLED)",Trust & Authority + Feature-Rich,Financial Dashboard,Navy (#0A1628) + Trust Blue + Gold accents,Security-first. Account overview. Transaction history. Mobile banking. Accessibility critical. Trust paramount.
|
||||||
|
45,Online Course/E-learning,"course, e, learning, online",Claymorphism + Vibrant & Block-based,"Motion-Driven, Flat Design",Feature-Rich Showcase + Social Proof,Education Dashboard,Vibrant learning colors + Progress green,Course catalog. Progress tracking. Video player. Quizzes. Certificates. Community forums. Gamification.
|
||||||
|
46,Non-profit/Charity,"charity, non, profit",Accessible & Ethical + Organic Biophilic,"Minimalism, Storytelling-Driven",Storytelling-Driven + Trust,Donation Analytics Dashboard,Cause-related colors + Trust + Warm,Impact stories. Donation flow. Transparency reports. Volunteer signup. Event calendar. Emotional connection.
|
||||||
|
47,Music Streaming,"music, streaming",Dark Mode (OLED) + Vibrant & Block-based,"Motion-Driven, Aurora UI",Feature-Rich Showcase,Media/Entertainment Dashboard,Dark (#121212) + Vibrant accents + Album art colors,Audio player. Playlist management. Artist pages. Personalization. Social features. Waveform visualizations.
|
||||||
|
48,Video Streaming/OTT,"ott, streaming, video",Dark Mode (OLED) + Motion-Driven,"Glassmorphism, Vibrant & Block-based",Hero-Centric Design + Feature-Rich,Media/Entertainment Dashboard,Dark bg + Content poster colors + Brand accent,Video player. Content discovery. Watchlist. Continue watching. Personalized recommendations. Thumbnail-heavy.
|
||||||
|
49,Job Board/Recruitment,"board, job, recruitment",Flat Design + Minimalism,"Vibrant & Block-based, Accessible & Ethical",Conversion-Optimized + Feature-Rich,HR Analytics Dashboard,Professional Blue + Success Green + Neutral,Job listings. Search/filter. Company profiles. Application tracking. Resume upload. Salary insights.
|
||||||
|
50,Marketplace (P2P),"buyers, listings, marketplace, p, platform, sellers",Vibrant & Block-based + Flat Design,"Micro-interactions, Trust & Authority",Feature-Rich Showcase + Social Proof,E-commerce Analytics,Trust colors + Category colors + Success green,Seller/buyer profiles. Listings. Reviews/ratings. Secure payment. Messaging. Search/filter. Trust badges.
|
||||||
|
51,Logistics/Delivery,"delivery, logistics",Minimalism + Flat Design,"Dark Mode (OLED), Micro-interactions",Feature-Rich Showcase + Conversion,Real-Time Monitoring + Route Analytics,Blue (#2563EB) + Orange (tracking) + Green (delivered),Real-time tracking. Delivery scheduling. Route optimization. Driver management. Status updates. Map integration.
|
||||||
|
52,Agriculture/Farm Tech,"agriculture, farm, tech",Organic Biophilic + Flat Design,"Minimalism, Accessible & Ethical",Feature-Rich Showcase + Trust,IoT Sensor Dashboard,Earth Green (#4A7C23) + Brown + Sky Blue,Crop monitoring. Weather data. IoT sensors. Yield tracking. Market prices. Sustainable imagery.
|
||||||
|
53,Construction/Architecture,"architecture, construction",Minimalism + 3D & Hyperrealism,"Brutalism, Swiss Modernism 2.0",Hero-Centric Design + Feature-Rich,Project Management Dashboard,Grey (#4A4A4A) + Orange (safety) + Blueprint Blue,Project portfolio. 3D renders. Timeline. Material specs. Team collaboration. Blueprint aesthetic.
|
||||||
|
54,Automotive/Car Dealership,"automotive, car, dealership",Motion-Driven + 3D & Hyperrealism,"Dark Mode (OLED), Glassmorphism",Hero-Centric Design + Feature-Rich,Sales Intelligence Dashboard,Brand colors + Metallic accents + Dark/Light,Vehicle showcase. 360° views. Comparison tools. Financing calculator. Test drive booking. High-quality imagery.
|
||||||
|
55,Photography Studio,"photography, studio",Motion-Driven + Minimalism,"Aurora UI, Glassmorphism",Storytelling-Driven + Hero-Centric,N/A - Portfolio focused,Black + White + Minimal accent,Portfolio gallery. Before/after. Service packages. Booking system. Client galleries. Full-bleed imagery.
|
||||||
|
56,Coworking Space,"coworking, space",Vibrant & Block-based + Glassmorphism,"Minimalism, Motion-Driven",Hero-Centric Design + Feature-Rich,Occupancy Dashboard,Energetic colors + Wood tones + Brand accent,Space tour. Membership plans. Booking system. Amenities. Community events. Virtual tour.
|
||||||
|
57,Cleaning Service,"appointment, booking, cleaning, consultation, service",Soft UI Evolution + Flat Design,"Minimalism, Micro-interactions",Conversion-Optimized + Trust,Service Analytics,Fresh Blue (#00B4D8) + Clean White + Green,Service packages. Booking system. Price calculator. Before/after gallery. Reviews. Trust badges.
|
||||||
|
58,Home Services (Plumber/Electrician),"appointment, booking, consultation, electrician, home, plumber, service, services",Flat Design + Trust & Authority,"Minimalism, Accessible & Ethical",Conversion-Optimized + Trust,Service Analytics,Trust Blue + Safety Orange + Professional grey,Service list. Emergency contact. Booking. Price transparency. Certifications. Local trust signals.
|
||||||
|
59,Childcare/Daycare,"childcare, daycare",Claymorphism + Vibrant & Block-based,"Soft UI Evolution, Accessible & Ethical",Social Proof-Focused + Trust,Parent Dashboard,Playful pastels + Safe colors + Warm accents,Programs. Staff profiles. Safety certifications. Parent portal. Activity updates. Cheerful imagery.
|
||||||
|
60,Senior Care/Elderly,"care, elderly, senior",Accessible & Ethical + Soft UI Evolution,"Minimalism, Neumorphism",Trust & Authority + Social Proof,Healthcare Analytics,Calm Blue + Warm neutrals + Large text,Care services. Staff qualifications. Facility tour. Family portal. Large touch targets. High contrast. Accessibility-first.
|
||||||
|
61,Medical Clinic,"clinic, medical",Accessible & Ethical + Minimalism,"Neumorphism, Trust & Authority",Trust & Authority + Conversion,Healthcare Analytics,Medical Blue (#0077B6) + Trust White + Calm Green,Services. Doctor profiles. Online booking. Patient portal. Insurance info. HIPAA compliant. Trust signals.
|
||||||
|
62,Pharmacy/Drug Store,"drug, pharmacy, store",Flat Design + Accessible & Ethical,"Minimalism, Trust & Authority",Conversion-Optimized + Trust,Inventory Dashboard,Pharmacy Green + Trust Blue + Clean White,Product catalog. Prescription upload. Refill reminders. Health info. Store locator. Safety certifications.
|
||||||
|
63,Dental Practice,"dental, practice",Soft UI Evolution + Minimalism,"Accessible & Ethical, Trust & Authority",Social Proof-Focused + Conversion,Patient Analytics,Fresh Blue + White + Smile Yellow accent,Services. Dentist profiles. Before/after. Online booking. Insurance. Patient testimonials. Friendly imagery.
|
||||||
|
64,Veterinary Clinic,"clinic, veterinary",Claymorphism + Accessible & Ethical,"Soft UI Evolution, Flat Design",Social Proof-Focused + Trust,Pet Health Dashboard,Caring Blue + Pet-friendly colors + Warm accents,Pet services. Vet profiles. Online booking. Pet portal. Emergency info. Friendly animal imagery.
|
||||||
|
65,Florist/Plant Shop,"florist, plant, shop",Organic Biophilic + Vibrant & Block-based,"Aurora UI, Motion-Driven",Hero-Centric Design + Conversion,E-commerce Analytics,Natural Green + Floral pinks/purples + Earth tones,Product catalog. Occasion categories. Delivery scheduling. Care guides. Seasonal collections. Beautiful imagery.
|
||||||
|
66,Bakery/Cafe,"bakery, cafe",Vibrant & Block-based + Soft UI Evolution,"Claymorphism, Motion-Driven",Hero-Centric Design + Conversion,N/A - Order focused,Warm Brown + Cream + Appetizing accents,Menu display. Online ordering. Location/hours. Catering. Seasonal specials. Appetizing photography.
|
||||||
|
67,Coffee Shop,"coffee, shop",Minimalism + Organic Biophilic,"Soft UI Evolution, Flat Design",Hero-Centric Design + Conversion,N/A - Order focused,Coffee Brown (#6F4E37) + Cream + Warm accents,Menu. Online ordering. Loyalty program. Location. Story/origin. Cozy aesthetic.
|
||||||
|
68,Brewery/Winery,"brewery, winery",Motion-Driven + Storytelling-Driven,"Dark Mode (OLED), Organic Biophilic",Storytelling-Driven + Hero-Centric,N/A - E-commerce focused,Deep amber/burgundy + Gold + Craft aesthetic,Product showcase. Story/heritage. Tasting notes. Events. Club membership. Artisanal imagery.
|
||||||
|
69,Airline,"ai, airline, artificial-intelligence, automation, machine-learning, ml",Minimalism + Glassmorphism,"Motion-Driven, Accessible & Ethical",Conversion-Optimized + Feature-Rich,Operations Dashboard,Sky Blue + Brand colors + Trust accents,Flight search. Booking. Check-in. Boarding pass. Loyalty program. Route maps. Mobile-first.
|
||||||
|
70,News/Media Platform,"content, entertainment, media, news, platform, streaming, video",Minimalism + Flat Design,"Dark Mode (OLED), Accessible & Ethical",Hero-Centric Design + Feature-Rich,Media Analytics Dashboard,Brand colors + High contrast + Category colors,Article layout. Breaking news. Categories. Search. Subscription. Mobile reading. Fast loading.
|
||||||
|
71,Magazine/Blog,"articles, blog, content, magazine, posts, writing",Swiss Modernism 2.0 + Motion-Driven,"Minimalism, Aurora UI",Storytelling-Driven + Hero-Centric,Content Analytics,Editorial colors + Brand primary + Clean white,Article showcase. Category navigation. Author profiles. Newsletter signup. Related content. Typography-focused.
|
||||||
|
72,Freelancer Platform,"freelancer, platform",Flat Design + Minimalism,"Vibrant & Block-based, Micro-interactions",Feature-Rich Showcase + Conversion,Marketplace Analytics,Professional Blue + Success Green + Neutral,Profile creation. Portfolio. Skill matching. Messaging. Payment. Reviews. Project management.
|
||||||
|
73,Consulting Firm,"consulting, firm",Trust & Authority + Minimalism,"Swiss Modernism 2.0, Accessible & Ethical",Trust & Authority + Feature-Rich,N/A - Lead generation,Navy + Gold + Professional grey,Service areas. Case studies. Team profiles. Thought leadership. Contact. Professional credibility.
|
||||||
|
74,Marketing Agency,"agency, creative, design, marketing, studio",Brutalism + Motion-Driven,"Vibrant & Block-based, Aurora UI",Storytelling-Driven + Feature-Rich,Campaign Analytics,Bold brand colors + Creative freedom,Portfolio. Case studies. Services. Team. Creative showcase. Results-focused. Bold aesthetic.
|
||||||
|
75,Event Management,"conference, event, management, meetup, registration, ticket",Vibrant & Block-based + Motion-Driven,"Glassmorphism, Aurora UI",Hero-Centric Design + Feature-Rich,Event Analytics,Event theme colors + Excitement accents,Event showcase. Registration. Agenda. Speakers. Sponsors. Ticket sales. Countdown timer.
|
||||||
|
76,Conference/Webinar Platform,"conference, platform, webinar",Glassmorphism + Minimalism,"Motion-Driven, Flat Design",Feature-Rich Showcase + Conversion,Attendee Analytics,Professional Blue + Video accent + Brand,Registration. Agenda. Speaker profiles. Live stream. Networking. Recording access. Virtual event features.
|
||||||
|
77,Membership/Community,"community, membership",Vibrant & Block-based + Soft UI Evolution,"Bento Box Grid, Micro-interactions",Social Proof-Focused + Conversion,Community Analytics,Community brand colors + Engagement accents,Member benefits. Pricing tiers. Community showcase. Events. Member directory. Exclusive content.
|
||||||
|
78,Newsletter Platform,"newsletter, platform",Minimalism + Flat Design,"Swiss Modernism 2.0, Accessible & Ethical",Minimal & Direct + Conversion,Email Analytics,Brand primary + Clean white + CTA accent,Subscribe form. Archive. About. Social proof. Sample content. Simple conversion.
|
||||||
|
79,Digital Products/Downloads,"digital, downloads, products",Vibrant & Block-based + Motion-Driven,"Glassmorphism, Bento Box Grid",Feature-Rich Showcase + Conversion,E-commerce Analytics,Product category colors + Brand + Success green,Product showcase. Preview. Pricing. Instant delivery. License management. Customer reviews.
|
||||||
|
80,Church/Religious Organization,"church, organization, religious",Accessible & Ethical + Soft UI Evolution,"Minimalism, Trust & Authority",Hero-Centric Design + Social Proof,N/A - Community focused,Warm Gold + Deep Purple/Blue + White,Service times. Events. Sermons. Community. Giving. Location. Welcoming imagery.
|
||||||
|
81,Sports Team/Club,"club, sports, team",Vibrant & Block-based + Motion-Driven,"Dark Mode (OLED), 3D & Hyperrealism",Hero-Centric Design + Feature-Rich,Performance Analytics,Team colors + Energetic accents,Schedule. Roster. News. Tickets. Merchandise. Fan engagement. Action imagery.
|
||||||
|
82,Museum/Gallery,"gallery, museum",Minimalism + Motion-Driven,"Swiss Modernism 2.0, 3D & Hyperrealism",Storytelling-Driven + Feature-Rich,Visitor Analytics,Art-appropriate neutrals + Exhibition accents,Exhibitions. Collections. Tickets. Events. Virtual tours. Educational content. Art-focused design.
|
||||||
|
83,Theater/Cinema,"cinema, theater",Dark Mode (OLED) + Motion-Driven,"Vibrant & Block-based, Glassmorphism",Hero-Centric Design + Conversion,Booking Analytics,Dark + Spotlight accents + Gold,Showtimes. Seat selection. Trailers. Coming soon. Membership. Dramatic imagery.
|
||||||
|
84,Language Learning App,"app, language, learning",Claymorphism + Vibrant & Block-based,"Micro-interactions, Flat Design",Feature-Rich Showcase + Social Proof,Learning Analytics,Playful colors + Progress indicators + Country flags,Lesson structure. Progress tracking. Gamification. Speaking practice. Community. Achievement badges.
|
||||||
|
85,Coding Bootcamp,"bootcamp, coding",Dark Mode (OLED) + Minimalism,"Cyberpunk UI, Flat Design",Feature-Rich Showcase + Social Proof,Student Analytics,Code editor colors + Brand + Success green,Curriculum. Projects. Career outcomes. Alumni. Pricing. Application. Terminal aesthetic.
|
||||||
|
86,Cybersecurity Platform,"cyber, security, platform",Cyberpunk UI + Dark Mode (OLED),"Neubrutalism, Minimal & Direct",Trust & Authority + Real-Time,Real-Time Monitoring + Heat Map,Matrix Green + Deep Black + Terminal feel,Data density. Threat visualization. Dark mode default.
|
||||||
|
87,Developer Tool / IDE,"dev, developer, tool, ide",Dark Mode (OLED) + Minimalism,"Flat Design, Bento Box Grid",Minimal & Direct + Documentation,Real-Time Monitor + Terminal,Dark syntax theme colors + Blue focus,Keyboard shortcuts. Syntax highlighting. Fast performance.
|
||||||
|
88,Biotech / Life Sciences,"biotech, biology, science",Glassmorphism + Clean Science,"Minimalism, Organic Biophilic",Storytelling-Driven + Research,Data-Dense + Predictive,Sterile White + DNA Blue + Life Green,Data accuracy. Cleanliness. Complex data viz.
|
||||||
|
89,Space Tech / Aerospace,"aerospace, space, tech",Holographic / HUD + Dark Mode,"Glassmorphism, 3D & Hyperrealism",Immersive Experience + Hero,Real-Time Monitoring + 3D,Deep Space Black + Star White + Metallic,High-tech feel. Precision. Telemetry data.
|
||||||
|
90,Architecture / Interior,"architecture, design, interior",Exaggerated Minimalism + High Imagery,"Swiss Modernism 2.0, Parallax",Portfolio Grid + Visuals,Project Management + Gallery,Monochrome + Gold Accent + High Imagery,High-res images. Typography. Space.
|
||||||
|
91,Quantum Computing Interface,"quantum, computing, physics, qubit, future, science",Holographic / HUD + Dark Mode,"Glassmorphism, Spatial UI",Immersive/Interactive Experience,3D Spatial Data + Real-Time Monitor,Quantum Blue #00FFFF + Deep Black + Interference patterns,Visualize complexity. Qubit states. Probability clouds. High-tech trust.
|
||||||
|
92,Biohacking / Longevity App,"biohacking, health, longevity, tracking, wellness, science",Biomimetic / Organic 2.0,"Minimalism, Dark Mode (OLED)",Data-Dense + Storytelling,Real-Time Monitor + Biological Data,Cellular Pink/Red + DNA Blue + Clean White,Personal data privacy. Scientific credibility. Biological visualizations.
|
||||||
|
93,Autonomous Drone Fleet Manager,"drone, autonomous, fleet, aerial, logistics, robotics",HUD / Sci-Fi FUI,"Real-Time Monitor, Spatial UI",Real-Time Monitor,Geographic + Real-Time,Tactical Green #00FF00 + Alert Red + Map Dark,Real-time telemetry. 3D spatial awareness. Latency indicators. Safety alerts.
|
||||||
|
94,Generative Art Platform,"art, generative, ai, creative, platform, gallery",Minimalism (Frame) + Gen Z Chaos,"Masonry Grid, Dark Mode",Bento Grid Showcase,Gallery / Portfolio,Neutral #F5F5F5 (Canvas) + User Content,Content is king. Fast loading. Creator attribution. Minting flow.
|
||||||
|
95,Spatial Computing OS / App,"spatial, vr, ar, vision, os, immersive, mixed-reality",Spatial UI (VisionOS),"Glassmorphism, 3D & Hyperrealism",Immersive/Interactive Experience,Spatial Dashboard,Frosted Glass + System Colors + Depth,Gaze/Pinch interaction. Depth hierarchy. Environment awareness.
|
||||||
|
96,Sustainable Energy / Climate Tech,"climate, energy, sustainable, green, tech, carbon",Organic Biophilic + E-Ink / Paper,"Data-Dense, Swiss Modernism",Interactive Demo + Data,Energy/Utilities Dashboard,Earth Green + Sky Blue + Solar Yellow,Data transparency. Impact visualization. Low-carbon web design.
|
||||||
|
24
.claude/skills/ui-ux-pro-max/data/prompts.csv
Normal file
24
.claude/skills/ui-ux-pro-max/data/prompts.csv
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
STT,Style Category,AI Prompt Keywords (Copy-Paste Ready),CSS/Technical Keywords,Implementation Checklist,Design System Variables
|
||||||
|
1,Minimalism & Swiss Style,"Design a minimalist landing page. Use: white space, geometric layouts, sans-serif fonts, high contrast, grid-based structure, essential elements only. Avoid shadows and gradients. Focus on clarity and functionality.","display: grid, gap: 2rem, font-family: sans-serif, color: #000 or #FFF, max-width: 1200px, clean borders, no box-shadow unless necessary","☐ Grid-based layout 12-16 columns, ☐ Typography hierarchy clear, ☐ No unnecessary decorations, ☐ WCAG AAA contrast verified, ☐ Mobile responsive grid","--spacing: 2rem, --border-radius: 0px, --font-weight: 400-700, --shadow: none, --accent-color: single primary only"
|
||||||
|
2,Neumorphism,"Create a neumorphic UI with soft 3D effects. Use light pastels, rounded corners (12-16px), subtle soft shadows (multiple layers), no hard lines, monochromatic color scheme with light/dark variations. Embossed/debossed effect on interactive elements.","border-radius: 12-16px, box-shadow: -5px -5px 15px rgba(0,0,0,0.1), 5px 5px 15px rgba(255,255,255,0.8), background: linear-gradient(145deg, color1, color2), transform: scale on press","☐ Rounded corners 12-16px consistent, ☐ Multiple shadow layers (2-3), ☐ Pastel color verified, ☐ Monochromatic palette checked, ☐ Press animation smooth 150ms","--border-radius: 14px, --shadow-soft-1: -5px -5px 15px, --shadow-soft-2: 5px 5px 15px, --color-light: #F5F5F5, --color-primary: single pastel"
|
||||||
|
3,Glassmorphism,"Design a glassmorphic interface with frosted glass effect. Use backdrop blur (10-20px), translucent overlays (rgba 10-30% opacity), vibrant background colors, subtle borders, light source reflection, layered depth. Perfect for modern overlays and cards.","backdrop-filter: blur(15px), background: rgba(255, 255, 255, 0.15), border: 1px solid rgba(255,255,255,0.2), -webkit-backdrop-filter: blur(15px), z-index layering for depth","☐ Backdrop-filter blur 10-20px, ☐ Translucent white 15-30% opacity, ☐ Subtle border 1px light, ☐ Vibrant background verified, ☐ Text contrast 4.5:1 checked","--blur-amount: 15px, --glass-opacity: 0.15, --border-color: rgba(255,255,255,0.2), --background: vibrant color, --text-color: light/dark based on BG"
|
||||||
|
4,Brutalism,"Create a brutalist design with raw, unpolished, stark aesthetic. Use pure primary colors (red, blue, yellow), black & white, no smooth transitions (instant), sharp corners, bold large typography, visible grid lines, default system fonts, intentional 'broken' design elements.","border-radius: 0px, transition: none or 0s, font-family: system-ui or monospace, font-weight: 700+, border: visible 2-4px, colors: #FF0000, #0000FF, #FFFF00, #000000, #FFFFFF","☐ No border-radius (0px), ☐ No transitions (instant), ☐ Bold typography (700+), ☐ Pure primary colors used, ☐ Visible grid/borders, ☐ Asymmetric layout intentional","--border-radius: 0px, --transition-duration: 0s, --font-weight: 700-900, --colors: primary only, --border-style: visible, --grid-visible: true"
|
||||||
|
5,3D & Hyperrealism,"Build an immersive 3D interface using realistic textures, 3D models (Three.js/Babylon.js), complex shadows, realistic lighting, parallax scrolling (3-5 layers), physics-based motion. Include skeuomorphic elements with tactile detail.","transform: translate3d, perspective: 1000px, WebGL canvas, Three.js/Babylon.js library, box-shadow: complex multi-layer, background: complex gradients, filter: drop-shadow()","☐ WebGL/Three.js integrated, ☐ 3D models loaded, ☐ Parallax 3-5 layers, ☐ Realistic lighting verified, ☐ Complex shadows rendered, ☐ Physics animation smooth 300-400ms","--perspective: 1000px, --parallax-layers: 5, --lighting-intensity: realistic, --shadow-depth: 20-40%, --animation-duration: 300-400ms"
|
||||||
|
6,Vibrant & Block-based,"Design an energetic, vibrant interface with bold block layouts, geometric shapes, high color contrast, large typography (32px+), animated background patterns, duotone effects. Perfect for startups and youth-focused apps. Use 4-6 contrasting colors from complementary/triadic schemes.","display: flex/grid with large gaps (48px+), font-size: 32px+, background: animated patterns (CSS), color: neon/vibrant colors, animation: continuous pattern movement","☐ Block layout with 48px+ gaps, ☐ Large typography 32px+, ☐ 4-6 vibrant colors max, ☐ Animated patterns active, ☐ Scroll-snap enabled, ☐ High contrast verified (7:1+)","--block-gap: 48px, --typography-size: 32px+, --color-palette: 4-6 vibrant colors, --animation: continuous pattern, --contrast-ratio: 7:1+"
|
||||||
|
7,Dark Mode (OLED),"Create an OLED-optimized dark interface with deep black (#000000), dark grey (#121212), midnight blue accents. Use minimal glow effects, vibrant neon accents (green, blue, gold, purple), high contrast text. Optimize for eye comfort and OLED power saving.","background: #000000 or #121212, color: #FFFFFF or #E0E0E0, text-shadow: 0 0 10px neon-color (sparingly), filter: brightness(0.8) if needed, color-scheme: dark","☐ Deep black #000000 or #121212, ☐ Vibrant neon accents used, ☐ Text contrast 7:1+, ☐ Minimal glow effects, ☐ OLED power optimization, ☐ No white (#FFFFFF) background","--bg-black: #000000, --bg-dark-grey: #121212, --text-primary: #FFFFFF, --accent-neon: neon colors, --glow-effect: minimal, --oled-optimized: true"
|
||||||
|
8,Accessible & Ethical,"Design with WCAG AAA compliance. Include: high contrast (7:1+), large text (16px+), keyboard navigation, screen reader compatibility, focus states visible (3-4px ring), semantic HTML, ARIA labels, skip links, reduced motion support (prefers-reduced-motion), 44x44px touch targets.","color-contrast: 7:1+, font-size: 16px+, outline: 3-4px on :focus-visible, aria-label, role attributes, @media (prefers-reduced-motion), touch-target: 44x44px, cursor: pointer","☐ WCAG AAA verified, ☐ 7:1+ contrast checked, ☐ Keyboard navigation tested, ☐ Screen reader tested, ☐ Focus visible 3-4px, ☐ Semantic HTML used, ☐ Touch targets 44x44px","--contrast-ratio: 7:1, --font-size-min: 16px, --focus-ring: 3-4px, --touch-target: 44x44px, --wcag-level: AAA, --keyboard-accessible: true, --sr-tested: true"
|
||||||
|
9,Claymorphism,"Design a playful, toy-like interface with soft 3D, chunky elements, bubbly aesthetic, rounded edges (16-24px), thick borders (3-4px), double shadows (inner + outer), pastel colors, smooth animations. Perfect for children's apps and creative tools.","border-radius: 16-24px, border: 3-4px solid, box-shadow: inset -2px -2px 8px, 4px 4px 8px, background: pastel-gradient, animation: soft bounce (cubic-bezier 0.34, 1.56)","☐ Border-radius 16-24px, ☐ Thick borders 3-4px, ☐ Double shadows (inner+outer), ☐ Pastel colors used, ☐ Soft bounce animations, ☐ Playful interactions","--border-radius: 20px, --border-width: 3-4px, --shadow-inner: inset -2px -2px 8px, --shadow-outer: 4px 4px 8px, --color-palette: pastels, --animation: bounce"
|
||||||
|
10,Aurora UI,"Create a vibrant gradient interface inspired by Northern Lights with mesh gradients, smooth color blends, flowing animations. Use complementary color pairs (blue-orange, purple-yellow), flowing background gradients, subtle continuous animations (8-12s loops), iridescent effects.","background: conic-gradient or radial-gradient with multiple stops, animation: @keyframes gradient (8-12s), background-size: 200% 200%, filter: saturate(1.2), blend-mode: screen or multiply","☐ Mesh/flowing gradients applied, ☐ 8-12s animation loop, ☐ Complementary colors used, ☐ Smooth color transitions, ☐ Iridescent effect subtle, ☐ Text contrast verified","--gradient-colors: complementary pairs, --animation-duration: 8-12s, --blend-mode: screen, --color-saturation: 1.2, --effect: iridescent, --loop-smooth: true"
|
||||||
|
11,Retro-Futurism,"Build a retro-futuristic (cyberpunk/vaporwave) interface with neon colors (blue, pink, cyan), deep black background, 80s aesthetic, CRT scanlines, glitch effects, neon glow text/borders, monospace fonts, geometric patterns. Use neon text-shadow and animated glitch effects.","color: neon colors (#0080FF, #FF006E, #00FFFF), text-shadow: 0 0 10px neon, background: #000 or #1A1A2E, font-family: monospace, animation: glitch (skew+offset), filter: hue-rotate","☐ Neon colors used, ☐ CRT scanlines effect, ☐ Glitch animations active, ☐ Monospace font, ☐ Deep black background, ☐ Glow effects applied, ☐ 80s patterns present","--neon-colors: #0080FF #FF006E #00FFFF, --background: #000000, --font-family: monospace, --effect: glitch+glow, --scanline-opacity: 0.3, --crt-effect: true"
|
||||||
|
12,Flat Design,"Create a flat, 2D interface with bold colors, no shadows/gradients, clean lines, simple geometric shapes, icon-heavy, typography-focused, minimal ornamentation. Use 4-6 solid, bright colors in a limited palette with high saturation.","box-shadow: none, background: solid color, border-radius: 0-4px, color: solid (no gradients), fill: solid, stroke: 1-2px, font: bold sans-serif, icons: simplified SVG","☐ No shadows/gradients, ☐ 4-6 solid colors max, ☐ Clean lines consistent, ☐ Simple shapes used, ☐ Icon-heavy layout, ☐ High saturation colors, ☐ Fast loading verified","--shadow: none, --color-palette: 4-6 solid, --border-radius: 2px, --gradient: none, --icons: simplified SVG, --animation: minimal 150-200ms"
|
||||||
|
13,Skeuomorphism,"Design a realistic, textured interface with 3D depth, real-world metaphors (leather, wood, metal), complex gradients (8-12 stops), realistic shadows, grain/texture overlays, tactile press animations. Perfect for premium/luxury products.","background: complex gradient (8-12 stops), box-shadow: realistic multi-layer, background-image: texture overlay (noise, grain), filter: drop-shadow, transform: scale on press (300-500ms)","☐ Realistic textures applied, ☐ Complex gradients 8-12 stops, ☐ Multi-layer shadows, ☐ Texture overlays present, ☐ Tactile animations smooth, ☐ Depth effect pronounced","--gradient-stops: 8-12, --texture-overlay: noise+grain, --shadow-layers: 3+, --animation-duration: 300-500ms, --depth-effect: pronounced, --tactile: true"
|
||||||
|
14,Liquid Glass,"Create a premium liquid glass effect with morphing shapes, flowing animations, chromatic aberration, iridescent gradients, smooth 400-600ms transitions. Use SVG morphing for shape changes, dynamic blur, smooth color transitions creating a fluid, premium feel.","animation: morphing SVG paths (400-600ms), backdrop-filter: blur + saturate, filter: hue-rotate + brightness, blend-mode: screen, background: iridescent gradient","☐ Morphing animations 400-600ms, ☐ Chromatic aberration applied, ☐ Dynamic blur active, ☐ Iridescent gradients, ☐ Smooth color transitions, ☐ Premium feel achieved","--morph-duration: 400-600ms, --blur-amount: 15px, --chromatic-aberration: true, --iridescent: true, --blend-mode: screen, --smooth-transitions: true"
|
||||||
|
15,Motion-Driven,"Build an animation-heavy interface with scroll-triggered animations, microinteractions, parallax scrolling (3-5 layers), smooth transitions (300-400ms), entrance animations, page transitions. Use Intersection Observer for scroll effects, transform for performance, GPU acceleration.","animation: @keyframes scroll-reveal, transform: translateY/X, Intersection Observer API, will-change: transform, scroll-behavior: smooth, animation-duration: 300-400ms","☐ Scroll animations active, ☐ Parallax 3-5 layers, ☐ Entrance animations smooth, ☐ Page transitions fluid, ☐ GPU accelerated, ☐ Prefers-reduced-motion respected","--animation-duration: 300-400ms, --parallax-layers: 5, --scroll-behavior: smooth, --gpu-accelerated: true, --entrance-animation: true, --page-transition: smooth"
|
||||||
|
16,Micro-interactions,"Design with delightful micro-interactions: small 50-100ms animations, gesture-based responses, tactile feedback, loading spinners, success/error states, subtle hover effects, haptic feedback triggers for mobile. Focus on responsive, contextual interactions.","animation: short 50-100ms, transition: hover states, @media (hover: hover) for desktop, :active for press, haptic-feedback CSS/API, loading animation smooth loop","☐ Micro-animations 50-100ms, ☐ Gesture-responsive, ☐ Tactile feedback visual/haptic, ☐ Loading spinners smooth, ☐ Success/error states clear, ☐ Hover effects subtle","--micro-animation-duration: 50-100ms, --gesture-responsive: true, --haptic-feedback: true, --loading-animation: smooth, --state-feedback: success+error"
|
||||||
|
17,Inclusive Design,"Design for universal accessibility: high contrast (7:1+), large text (16px+), keyboard-only navigation, screen reader optimization, WCAG AAA compliance, symbol-based color indicators (not color-only), haptic feedback, voice interaction support, reduced motion options.","aria-* attributes complete, role attributes semantic, focus-visible: 3-4px ring, color-contrast: 7:1+, @media (prefers-reduced-motion), alt text on all images, form labels properly associated","☐ WCAG AAA verified, ☐ 7:1+ contrast all text, ☐ Keyboard accessible (Tab/Enter), ☐ Screen reader tested, ☐ Focus visible 3-4px, ☐ No color-only indicators, ☐ Haptic fallback","--contrast-ratio: 7:1, --font-size: 16px+, --keyboard-accessible: true, --sr-compatible: true, --wcag-level: AAA, --color-symbols: true, --haptic: enabled"
|
||||||
|
18,Zero Interface,"Create a voice-first, gesture-based, AI-driven interface with minimal visible UI, progressive disclosure, voice recognition UI, gesture detection, AI predictions, smart suggestions, context-aware actions. Hide controls until needed.","voice-commands: Web Speech API, gesture-detection: touch events, AI-predictions: hidden by default (reveal on hover), progressive-disclosure: show on demand, minimal UI visible","☐ Voice commands responsive, ☐ Gesture detection active, ☐ AI predictions hidden/revealed, ☐ Progressive disclosure working, ☐ Minimal visible UI, ☐ Smart suggestions contextual","--voice-ui: enabled, --gesture-detection: active, --ai-predictions: smart, --progressive-disclosure: true, --visible-ui: minimal, --context-aware: true"
|
||||||
|
19,Soft UI Evolution,"Design evolved neumorphism with improved contrast (WCAG AA+), modern aesthetics, subtle depth, accessibility focus. Use soft shadows (softer than flat but clearer than pure neumorphism), better color hierarchy, improved focus states, modern 200-300ms animations.","box-shadow: softer multi-layer (0 2px 4px), background: improved contrast pastels, border-radius: 8-12px, animation: 200-300ms smooth, outline: 2-3px on focus, contrast: 4.5:1+","☐ Improved contrast AA/AAA, ☐ Soft shadows modern, ☐ Border-radius 8-12px, ☐ Animations 200-300ms, ☐ Focus states visible, ☐ Color hierarchy clear","--shadow-soft: modern blend, --border-radius: 10px, --animation-duration: 200-300ms, --contrast-ratio: 4.5:1+, --color-hierarchy: improved, --wcag-level: AA+"
|
||||||
|
20,Bento Grids,"Design a Bento Grid layout. Use: modular grid system, rounded corners (16-24px), different card sizes (1x1, 2x1, 2x2), card-based hierarchy, soft backgrounds (#F5F5F7), subtle borders, content-first, Apple-style aesthetic.","display: grid, grid-template-columns: repeat(auto-fit, minmax(...)), gap: 1rem, border-radius: 20px, background: #FFF, box-shadow: subtle","☐ Grid layout (CSS Grid), ☐ Rounded corners 16-24px, ☐ Varied card spans, ☐ Content fits card size, ☐ Responsive re-flow, ☐ Apple-like aesthetic","--grid-gap: 20px, --card-radius: 24px, --card-bg: #FFFFFF, --page-bg: #F5F5F7, --shadow: soft"
|
||||||
|
21,Neubrutalism,"Design a neubrutalist interface. Use: high contrast, hard black borders (3px+), bright pop colors, no blur, sharp or slightly rounded corners, bold typography, hard shadows (offset 4px 4px), raw aesthetic but functional.","border: 3px solid black, box-shadow: 5px 5px 0px black, colors: #FFDB58 #FF6B6B #4ECDC4, font-weight: 700, no gradients","☐ Hard borders (2-4px), ☐ Hard offset shadows, ☐ High saturation colors, ☐ Bold typography, ☐ No blurs/gradients, ☐ Distinctive 'ugly-cute' look","--border-width: 3px, --shadow-offset: 4px, --shadow-color: #000, --colors: high saturation, --font: bold sans"
|
||||||
|
22,HUD / Sci-Fi FUI,"Design a futuristic HUD (Heads Up Display) or FUI. Use: thin lines (1px), neon cyan/blue on black, technical markers, decorative brackets, data visualization, monospaced tech fonts, glowing elements, transparency.","border: 1px solid rgba(0,255,255,0.5), color: #00FFFF, background: transparent or rgba(0,0,0,0.8), font-family: monospace, text-shadow: 0 0 5px cyan","☐ Fine lines 1px, ☐ Neon glow text/borders, ☐ Monospaced font, ☐ Dark/Transparent BG, ☐ Decorative tech markers, ☐ Holographic feel","--hud-color: #00FFFF, --bg-color: rgba(0,10,20,0.9), --line-width: 1px, --glow: 0 0 5px, --font: monospace"
|
||||||
|
23,Pixel Art,"Design a pixel art inspired interface. Use: pixelated fonts, 8-bit or 16-bit aesthetic, sharp edges (image-rendering: pixelated), limited color palette, blocky UI elements, retro gaming feel.","font-family: 'Press Start 2P', image-rendering: pixelated, box-shadow: 4px 0 0 #000 (pixel border), no anti-aliasing","☐ Pixelated fonts loaded, ☐ Images sharp (no blur), ☐ CSS box-shadow for pixel borders, ☐ Retro palette, ☐ Blocky layout","--pixel-size: 4px, --font: pixel font, --border-style: pixel-shadow, --anti-alias: none"
|
||||||
|
53
.claude/skills/ui-ux-pro-max/data/stacks/flutter.csv
Normal file
53
.claude/skills/ui-ux-pro-max/data/stacks/flutter.csv
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Widgets,Use StatelessWidget when possible,Immutable widgets are simpler,StatelessWidget for static UI,StatefulWidget for everything,class MyWidget extends StatelessWidget,class MyWidget extends StatefulWidget (static),Medium,https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html
|
||||||
|
2,Widgets,Keep widgets small,Single responsibility principle,Extract widgets into smaller pieces,Large build methods,Column(children: [Header() Content()]),500+ line build method,Medium,
|
||||||
|
3,Widgets,Use const constructors,Compile-time constants for performance,const MyWidget() when possible,Non-const for static widgets,const Text('Hello'),Text('Hello') for literals,High,https://dart.dev/guides/language/language-tour#constant-constructors
|
||||||
|
4,Widgets,Prefer composition over inheritance,Combine widgets using children,Compose widgets,Extend widget classes,Container(child: MyContent()),class MyContainer extends Container,Medium,
|
||||||
|
5,State,Use setState correctly,Minimal state in StatefulWidget,setState for UI state changes,setState for business logic,setState(() { _counter++; }),Complex logic in setState,Medium,https://api.flutter.dev/flutter/widgets/State/setState.html
|
||||||
|
6,State,Avoid setState in build,Never call setState during build,setState in callbacks only,setState in build method,onPressed: () => setState(() {}),build() { setState(); },High,
|
||||||
|
7,State,Use state management for complex apps,Provider Riverpod BLoC,State management for shared state,setState for global state,Provider.of<MyState>(context),Global setState calls,Medium,
|
||||||
|
8,State,Prefer Riverpod or Provider,Recommended state solutions,Riverpod for new projects,InheritedWidget manually,ref.watch(myProvider),Custom InheritedWidget,Medium,https://riverpod.dev/
|
||||||
|
9,State,Dispose resources,Clean up controllers and subscriptions,dispose() for cleanup,Memory leaks from subscriptions,@override void dispose() { controller.dispose(); },No dispose implementation,High,
|
||||||
|
10,Layout,Use Column and Row,Basic layout widgets,Column Row for linear layouts,Stack for simple layouts,"Column(children: [Text(), Button()])",Stack for vertical list,Medium,https://api.flutter.dev/flutter/widgets/Column-class.html
|
||||||
|
11,Layout,Use Expanded and Flexible,Control flex behavior,Expanded to fill space,Fixed sizes in flex containers,Expanded(child: Container()),Container(width: 200) in Row,Medium,
|
||||||
|
12,Layout,Use SizedBox for spacing,Consistent spacing,SizedBox for gaps,Container for spacing only,SizedBox(height: 16),Container(height: 16),Low,
|
||||||
|
13,Layout,Use LayoutBuilder for responsive,Respond to constraints,LayoutBuilder for adaptive layouts,Fixed sizes for responsive,LayoutBuilder(builder: (context constraints) {}),Container(width: 375),Medium,https://api.flutter.dev/flutter/widgets/LayoutBuilder-class.html
|
||||||
|
14,Layout,Avoid deep nesting,Keep widget tree shallow,Extract deeply nested widgets,10+ levels of nesting,Extract widget to method or class,Column(Row(Column(Row(...)))),Medium,
|
||||||
|
15,Lists,Use ListView.builder,Lazy list building,ListView.builder for long lists,ListView with children for large lists,"ListView.builder(itemCount: 100, itemBuilder: ...)",ListView(children: items.map(...).toList()),High,https://api.flutter.dev/flutter/widgets/ListView-class.html
|
||||||
|
16,Lists,Provide itemExtent when known,Skip measurement,itemExtent for fixed height items,No itemExtent for uniform lists,ListView.builder(itemExtent: 50),ListView.builder without itemExtent,Medium,
|
||||||
|
17,Lists,Use keys for stateful items,Preserve widget state,Key for stateful list items,No key for dynamic lists,ListTile(key: ValueKey(item.id)),ListTile without key,High,
|
||||||
|
18,Lists,Use SliverList for custom scroll,Custom scroll effects,CustomScrollView with Slivers,Nested ListViews,CustomScrollView(slivers: [SliverList()]),ListView inside ListView,Medium,https://api.flutter.dev/flutter/widgets/SliverList-class.html
|
||||||
|
19,Navigation,Use Navigator 2.0 or GoRouter,Declarative routing,go_router for navigation,Navigator.push for complex apps,GoRouter(routes: [...]),Navigator.push everywhere,Medium,https://pub.dev/packages/go_router
|
||||||
|
20,Navigation,Use named routes,Organized navigation,Named routes for clarity,Anonymous routes,Navigator.pushNamed(context '/home'),Navigator.push(context MaterialPageRoute()),Low,
|
||||||
|
21,Navigation,Handle back button (PopScope),Android back behavior and predictive back (Android 14+),Use PopScope widget (WillPopScope is deprecated),Use WillPopScope,"PopScope(canPop: false, onPopInvoked: (didPop) => ...)",WillPopScope(onWillPop: ...),High,https://api.flutter.dev/flutter/widgets/PopScope-class.html
|
||||||
|
22,Navigation,Pass typed arguments,Type-safe route arguments,Typed route arguments,Dynamic arguments,MyRoute(id: '123'),arguments: {'id': '123'},Medium,
|
||||||
|
23,Async,Use FutureBuilder,Async UI building,FutureBuilder for async data,setState for async,FutureBuilder(future: fetchData()),fetchData().then((d) => setState()),Medium,https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html
|
||||||
|
24,Async,Use StreamBuilder,Stream UI building,StreamBuilder for streams,Manual stream subscription,StreamBuilder(stream: myStream),stream.listen in initState,Medium,https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html
|
||||||
|
25,Async,Handle loading and error states,Complete async UI states,ConnectionState checks,Only success state,if (snapshot.connectionState == ConnectionState.waiting),No loading indicator,High,
|
||||||
|
26,Async,Cancel subscriptions,Clean up stream subscriptions,Cancel in dispose,Memory leaks,subscription.cancel() in dispose,No subscription cleanup,High,
|
||||||
|
27,Theming,Use ThemeData,Consistent theming,ThemeData for app theme,Hardcoded colors,Theme.of(context).primaryColor,Color(0xFF123456) everywhere,Medium,https://api.flutter.dev/flutter/material/ThemeData-class.html
|
||||||
|
28,Theming,Use ColorScheme,Material 3 color system,ColorScheme for colors,Individual color properties,colorScheme: ColorScheme.fromSeed(),primaryColor: Colors.blue,Medium,
|
||||||
|
29,Theming,Access theme via context,Dynamic theme access,Theme.of(context),Static theme reference,Theme.of(context).textTheme.bodyLarge,TextStyle(fontSize: 16),Medium,
|
||||||
|
30,Theming,Support dark mode,Respect system theme,darkTheme in MaterialApp,Light theme only,"MaterialApp(theme: light, darkTheme: dark)",MaterialApp(theme: light),Medium,
|
||||||
|
31,Animation,Use implicit animations,Simple animations,AnimatedContainer AnimatedOpacity,Explicit for simple transitions,AnimatedContainer(duration: Duration()),AnimationController for fade,Low,https://api.flutter.dev/flutter/widgets/AnimatedContainer-class.html
|
||||||
|
32,Animation,Use AnimationController for complex,Fine-grained control,AnimationController with Ticker,Implicit for complex sequences,AnimationController(vsync: this),AnimatedContainer for staggered,Medium,
|
||||||
|
33,Animation,Dispose AnimationControllers,Clean up animation resources,dispose() for controllers,Memory leaks,controller.dispose() in dispose,No controller disposal,High,
|
||||||
|
34,Animation,Use Hero for transitions,Shared element transitions,Hero for navigation animations,Manual shared element,Hero(tag: 'image' child: Image()),Custom shared element animation,Low,https://api.flutter.dev/flutter/widgets/Hero-class.html
|
||||||
|
35,Forms,Use Form widget,Form validation,Form with GlobalKey,Individual validation,Form(key: _formKey child: ...),TextField without Form,Medium,https://api.flutter.dev/flutter/widgets/Form-class.html
|
||||||
|
36,Forms,Use TextEditingController,Control text input,Controller for text fields,onChanged for all text,final controller = TextEditingController(),onChanged: (v) => setState(),Medium,
|
||||||
|
37,Forms,Validate on submit,Form validation flow,_formKey.currentState!.validate(),Skip validation,if (_formKey.currentState!.validate()),Submit without validation,High,
|
||||||
|
38,Forms,Dispose controllers,Clean up text controllers,dispose() for controllers,Memory leaks,controller.dispose() in dispose,No controller disposal,High,
|
||||||
|
39,Performance,Use const widgets,Reduce rebuilds,const for static widgets,No const for literals,const Icon(Icons.add),Icon(Icons.add),High,
|
||||||
|
40,Performance,Avoid rebuilding entire tree,Minimal rebuild scope,Isolate changing widgets,setState on parent,Consumer only around changing widget,setState on root widget,High,
|
||||||
|
41,Performance,Use RepaintBoundary,Isolate repaints,RepaintBoundary for animations,Full screen repaints,RepaintBoundary(child: AnimatedWidget()),Animation without boundary,Medium,https://api.flutter.dev/flutter/widgets/RepaintBoundary-class.html
|
||||||
|
42,Performance,Profile with DevTools,Measure before optimizing,Flutter DevTools profiling,Guess at performance,DevTools performance tab,Optimize without measuring,Medium,https://docs.flutter.dev/tools/devtools
|
||||||
|
43,Accessibility,Use Semantics widget,Screen reader support,Semantics for accessibility,Missing accessibility info,Semantics(label: 'Submit button'),GestureDetector without semantics,High,https://api.flutter.dev/flutter/widgets/Semantics-class.html
|
||||||
|
44,Accessibility,Support large fonts,MediaQuery text scaling,MediaQuery.textScaleFactor,Fixed font sizes,style: Theme.of(context).textTheme,TextStyle(fontSize: 14),High,
|
||||||
|
45,Accessibility,Test with screen readers,TalkBack and VoiceOver,Test accessibility regularly,Skip accessibility testing,Regular TalkBack testing,No screen reader testing,High,
|
||||||
|
46,Testing,Use widget tests,Test widget behavior,WidgetTester for UI tests,Unit tests only,testWidgets('...' (tester) async {}),Only test() for UI,Medium,https://docs.flutter.dev/testing
|
||||||
|
47,Testing,Use integration tests,Full app testing,integration_test package,Manual testing only,IntegrationTestWidgetsFlutterBinding,Manual E2E testing,Medium,
|
||||||
|
48,Testing,Mock dependencies,Isolate tests,Mockito or mocktail,Real dependencies in tests,when(mock.method()).thenReturn(),Real API calls in tests,Medium,
|
||||||
|
49,Platform,Use Platform checks,Platform-specific code,Platform.isIOS Platform.isAndroid,Same code for all platforms,if (Platform.isIOS) {},Hardcoded iOS behavior,Medium,
|
||||||
|
50,Platform,Use kIsWeb for web,Web platform detection,kIsWeb for web checks,Platform for web,if (kIsWeb) {},Platform.isWeb (doesn't exist),Medium,
|
||||||
|
51,Packages,Use pub.dev packages,Community packages,Popular maintained packages,Custom implementations,cached_network_image,Custom image cache,Medium,https://pub.dev/
|
||||||
|
52,Packages,Check package quality,Quality before adding,Pub points and popularity,Any package without review,100+ pub points,Unmaintained packages,Medium,
|
||||||
|
56
.claude/skills/ui-ux-pro-max/data/stacks/html-tailwind.csv
Normal file
56
.claude/skills/ui-ux-pro-max/data/stacks/html-tailwind.csv
Normal file
@ -0,0 +1,56 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Animation,Use Tailwind animate utilities,Built-in animations are optimized and respect reduced-motion,Use animate-pulse animate-spin animate-ping,Custom @keyframes for simple effects,animate-pulse,@keyframes pulse {...},Medium,https://tailwindcss.com/docs/animation
|
||||||
|
2,Animation,Limit bounce animations,Continuous bounce is distracting and causes motion sickness,Use animate-bounce sparingly on CTAs only,Multiple bounce animations on page,Single CTA with animate-bounce,5+ elements with animate-bounce,High,
|
||||||
|
3,Animation,Transition duration,Use appropriate transition speeds for UI feedback,duration-150 to duration-300 for UI,duration-1000 or longer for UI elements,transition-all duration-200,transition-all duration-1000,Medium,https://tailwindcss.com/docs/transition-duration
|
||||||
|
4,Animation,Hover transitions,Add smooth transitions on hover state changes,Add transition class with hover states,Instant hover changes without transition,hover:bg-gray-100 transition-colors,hover:bg-gray-100 (no transition),Low,
|
||||||
|
5,Z-Index,Use Tailwind z-* scale,Consistent stacking context with predefined scale,z-0 z-10 z-20 z-30 z-40 z-50,Arbitrary z-index values,z-50 for modals,z-[9999],Medium,https://tailwindcss.com/docs/z-index
|
||||||
|
6,Z-Index,Fixed elements z-index,Fixed navigation and modals need explicit z-index,z-50 for nav z-40 for dropdowns,Relying on DOM order for stacking,fixed top-0 z-50,fixed top-0 (no z-index),High,
|
||||||
|
7,Z-Index,Negative z-index for backgrounds,Use negative z-index for decorative backgrounds,z-[-1] for background elements,Positive z-index for backgrounds,-z-10 for decorative,z-10 for background,Low,
|
||||||
|
8,Layout,Container max-width,Limit content width for readability,max-w-7xl mx-auto for main content,Full-width content on large screens,max-w-7xl mx-auto px-4,w-full (no max-width),Medium,https://tailwindcss.com/docs/container
|
||||||
|
9,Layout,Responsive padding,Adjust padding for different screen sizes,px-4 md:px-6 lg:px-8,Same padding all sizes,px-4 sm:px-6 lg:px-8,px-8 (same all sizes),Medium,
|
||||||
|
10,Layout,Grid gaps,Use consistent gap utilities for spacing,gap-4 gap-6 gap-8,Margins on individual items,grid gap-6,grid with mb-4 on each item,Medium,https://tailwindcss.com/docs/gap
|
||||||
|
11,Layout,Flexbox alignment,Use flex utilities for alignment,items-center justify-between,Multiple nested wrappers,flex items-center justify-between,Nested divs for alignment,Low,
|
||||||
|
12,Images,Aspect ratio,Maintain consistent image aspect ratios,aspect-video aspect-square,No aspect ratio on containers,aspect-video rounded-lg,No aspect control,Medium,https://tailwindcss.com/docs/aspect-ratio
|
||||||
|
13,Images,Object fit,Control image scaling within containers,object-cover object-contain,Stretched distorted images,object-cover w-full h-full,No object-fit,Medium,https://tailwindcss.com/docs/object-fit
|
||||||
|
14,Images,Lazy loading,Defer loading of off-screen images,loading='lazy' on images,All images eager load,<img loading='lazy'>,<img> without lazy,High,
|
||||||
|
15,Images,Responsive images,Serve appropriate image sizes,srcset and sizes attributes,Same large image all devices,srcset with multiple sizes,4000px image everywhere,High,
|
||||||
|
16,Typography,Prose plugin,Use @tailwindcss/typography for rich text,prose prose-lg for article content,Custom styles for markdown,prose prose-lg max-w-none,Custom text styling,Medium,https://tailwindcss.com/docs/typography-plugin
|
||||||
|
17,Typography,Line height,Use appropriate line height for readability,leading-relaxed for body text,Default tight line height,leading-relaxed (1.625),leading-none or leading-tight,Medium,https://tailwindcss.com/docs/line-height
|
||||||
|
18,Typography,Font size scale,Use consistent text size scale,text-sm text-base text-lg text-xl,Arbitrary font sizes,text-lg,text-[17px],Low,https://tailwindcss.com/docs/font-size
|
||||||
|
19,Typography,Text truncation,Handle long text gracefully,truncate or line-clamp-*,Overflow breaking layout,line-clamp-2,No overflow handling,Medium,https://tailwindcss.com/docs/text-overflow
|
||||||
|
20,Colors,Opacity utilities,Use color opacity utilities,bg-black/50 text-white/80,Separate opacity class,bg-black/50,bg-black opacity-50,Low,https://tailwindcss.com/docs/background-color
|
||||||
|
21,Colors,Dark mode,Support dark mode with dark: prefix,dark:bg-gray-900 dark:text-white,No dark mode support,dark:bg-gray-900,Only light theme,Medium,https://tailwindcss.com/docs/dark-mode
|
||||||
|
22,Colors,Semantic colors,Use semantic color naming in config,primary secondary danger success,Generic color names in components,bg-primary,bg-blue-500 everywhere,Medium,
|
||||||
|
23,Spacing,Consistent spacing scale,Use Tailwind spacing scale consistently,p-4 m-6 gap-8,Arbitrary pixel values,p-4 (1rem),p-[15px],Low,https://tailwindcss.com/docs/customizing-spacing
|
||||||
|
24,Spacing,Negative margins,Use sparingly for overlapping effects,-mt-4 for overlapping elements,Negative margins for layout fixing,-mt-8 for card overlap,-m-2 to fix spacing issues,Medium,
|
||||||
|
25,Spacing,Space between,Use space-y-* for vertical lists,space-y-4 on flex/grid column,Margin on each child,space-y-4,Each child has mb-4,Low,https://tailwindcss.com/docs/space
|
||||||
|
26,Forms,Focus states,Always show focus indicators,focus:ring-2 focus:ring-blue-500,Remove focus outline,focus:ring-2 focus:ring-offset-2,focus:outline-none (no replacement),High,
|
||||||
|
27,Forms,Input sizing,Consistent input dimensions,h-10 px-3 for inputs,Inconsistent input heights,h-10 w-full px-3,Various heights per input,Medium,
|
||||||
|
28,Forms,Disabled states,Clear disabled styling,disabled:opacity-50 disabled:cursor-not-allowed,No disabled indication,disabled:opacity-50,Same style as enabled,Medium,
|
||||||
|
29,Forms,Placeholder styling,Style placeholder text appropriately,placeholder:text-gray-400,Dark placeholder text,placeholder:text-gray-400,Default dark placeholder,Low,
|
||||||
|
30,Responsive,Mobile-first approach,Start with mobile styles and add breakpoints,Default mobile + md: lg: xl:,Desktop-first approach,text-sm md:text-base,text-base max-md:text-sm,Medium,https://tailwindcss.com/docs/responsive-design
|
||||||
|
31,Responsive,Breakpoint testing,Test at standard breakpoints,320 375 768 1024 1280 1536,Only test on development device,Test all breakpoints,Single device testing,High,
|
||||||
|
32,Responsive,Hidden/shown utilities,Control visibility per breakpoint,hidden md:block,Different content per breakpoint,hidden md:flex,Separate mobile/desktop components,Low,https://tailwindcss.com/docs/display
|
||||||
|
33,Buttons,Button sizing,Consistent button dimensions,px-4 py-2 or px-6 py-3,Inconsistent button sizes,px-4 py-2 text-sm,Various padding per button,Medium,
|
||||||
|
34,Buttons,Touch targets,Minimum 44px touch target on mobile,min-h-[44px] on mobile,Small buttons on mobile,min-h-[44px] min-w-[44px],h-8 w-8 on mobile,High,
|
||||||
|
35,Buttons,Loading states,Show loading feedback,disabled + spinner icon,Clickable during loading,<Button disabled><Spinner/></Button>,Button without loading state,High,
|
||||||
|
36,Buttons,Icon buttons,Accessible icon-only buttons,aria-label on icon buttons,Icon button without label,<button aria-label='Close'><XIcon/></button>,<button><XIcon/></button>,High,
|
||||||
|
37,Cards,Card structure,Consistent card styling,rounded-lg shadow-md p-6,Inconsistent card styles,rounded-2xl shadow-lg p-6,Mixed card styling,Low,
|
||||||
|
38,Cards,Card hover states,Interactive cards should have hover feedback,hover:shadow-lg transition-shadow,No hover on clickable cards,hover:shadow-xl transition-shadow,Static cards that are clickable,Medium,
|
||||||
|
39,Cards,Card spacing,Consistent internal card spacing,space-y-4 for card content,Inconsistent internal spacing,space-y-4 or p-6,Mixed mb-2 mb-4 mb-6,Low,
|
||||||
|
40,Accessibility,Screen reader text,Provide context for screen readers,sr-only for hidden labels,Missing context for icons,<span class='sr-only'>Close menu</span>,No label for icon button,High,https://tailwindcss.com/docs/screen-readers
|
||||||
|
41,Accessibility,Focus visible,Show focus only for keyboard users,focus-visible:ring-2,Focus on all interactions,focus-visible:ring-2,focus:ring-2 (shows on click too),Medium,
|
||||||
|
42,Accessibility,Reduced motion,Respect user motion preferences,motion-reduce:animate-none,Ignore motion preferences,motion-reduce:transition-none,No reduced motion support,High,https://tailwindcss.com/docs/hover-focus-and-other-states#prefers-reduced-motion
|
||||||
|
43,Performance,Configure content paths,Tailwind needs to know where classes are used,Use 'content' array in config,Use deprecated 'purge' option (v2),"content: ['./src/**/*.{js,ts,jsx,tsx}']",purge: [...],High,https://tailwindcss.com/docs/content-configuration
|
||||||
|
44,Performance,JIT mode,Use JIT for faster builds and smaller bundles,JIT enabled (default in v3),Full CSS in development,Tailwind v3 defaults,Tailwind v2 without JIT,Medium,
|
||||||
|
45,Performance,Avoid @apply bloat,Use @apply sparingly,Direct utilities in HTML,Heavy @apply usage,class='px-4 py-2 rounded',@apply px-4 py-2 rounded;,Low,https://tailwindcss.com/docs/reusing-styles
|
||||||
|
46,Plugins,Official plugins,Use official Tailwind plugins,@tailwindcss/forms typography aspect-ratio,Custom implementations,@tailwindcss/forms,Custom form reset CSS,Medium,https://tailwindcss.com/docs/plugins
|
||||||
|
47,Plugins,Custom utilities,Create utilities for repeated patterns,Custom utility in config,Repeated arbitrary values,Custom shadow utility,"shadow-[0_4px_20px_rgba(0,0,0,0.1)] everywhere",Medium,
|
||||||
|
48,Layout,Container Queries,Use @container for component-based responsiveness,Use @container and @lg: etc.,Media queries for component internals,@container @lg:grid-cols-2,@media (min-width: ...) inside component,Medium,https://github.com/tailwindlabs/tailwindcss-container-queries
|
||||||
|
49,Interactivity,Group and Peer,Style based on parent/sibling state,group-hover peer-checked,JS for simple state interactions,group-hover:text-blue-500,onMouseEnter={() => setHover(true)},Low,https://tailwindcss.com/docs/hover-focus-and-other-states#styling-based-on-parent-state
|
||||||
|
50,Customization,Arbitrary Values,Use [] for one-off values,w-[350px] for specific needs,Creating config for single use,top-[117px] (if strictly needed),style={{ top: '117px' }},Low,https://tailwindcss.com/docs/adding-custom-styles#using-arbitrary-values
|
||||||
|
51,Colors,Theme color variables,Define colors in Tailwind theme and use directly,bg-primary text-success border-cta,bg-[var(--color-primary)] text-[var(--color-success)],bg-primary,bg-[var(--color-primary)],Medium,https://tailwindcss.com/docs/customizing-colors
|
||||||
|
52,Colors,Use bg-linear-to-* for gradients,Tailwind v4 uses bg-linear-to-* syntax for gradients,bg-linear-to-r bg-linear-to-b,bg-gradient-to-* (deprecated in v4),bg-linear-to-r from-blue-500 to-purple-500,bg-gradient-to-r from-blue-500 to-purple-500,Medium,https://tailwindcss.com/docs/background-image
|
||||||
|
53,Layout,Use shrink-0 shorthand,Shorter class name for flex-shrink-0,shrink-0 shrink,flex-shrink-0 flex-shrink,shrink-0,flex-shrink-0,Low,https://tailwindcss.com/docs/flex-shrink
|
||||||
|
54,Layout,Use size-* for square dimensions,Single utility for equal width and height,size-4 size-8 size-12,Separate h-* w-* for squares,size-6,h-6 w-6,Low,https://tailwindcss.com/docs/size
|
||||||
|
55,Images,SVG explicit dimensions,Add width/height attributes to SVGs to prevent layout shift before CSS loads,<svg class='size-6' width='24' height='24'>,SVG without explicit dimensions,<svg class='size-6' width='24' height='24'>,<svg class='size-6'>,High,
|
||||||
|
53
.claude/skills/ui-ux-pro-max/data/stacks/nextjs.csv
Normal file
53
.claude/skills/ui-ux-pro-max/data/stacks/nextjs.csv
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Routing,Use App Router for new projects,App Router is the recommended approach in Next.js 14+,app/ directory with page.tsx,pages/ for new projects,app/dashboard/page.tsx,pages/dashboard.tsx,Medium,https://nextjs.org/docs/app
|
||||||
|
2,Routing,Use file-based routing,Create routes by adding files in app directory,page.tsx for routes layout.tsx for layouts,Manual route configuration,app/blog/[slug]/page.tsx,Custom router setup,Medium,https://nextjs.org/docs/app/building-your-application/routing
|
||||||
|
3,Routing,Colocate related files,Keep components styles tests with their routes,Component files alongside page.tsx,Separate components folder,app/dashboard/_components/,components/dashboard/,Low,
|
||||||
|
4,Routing,Use route groups for organization,Group routes without affecting URL,Parentheses for route groups,Nested folders affecting URL,(marketing)/about/page.tsx,marketing/about/page.tsx,Low,https://nextjs.org/docs/app/building-your-application/routing/route-groups
|
||||||
|
5,Routing,Handle loading states,Use loading.tsx for route loading UI,loading.tsx alongside page.tsx,Manual loading state management,app/dashboard/loading.tsx,useState for loading in page,Medium,https://nextjs.org/docs/app/building-your-application/routing/loading-ui-and-streaming
|
||||||
|
6,Routing,Handle errors with error.tsx,Catch errors at route level,error.tsx with reset function,try/catch in every component,app/dashboard/error.tsx,try/catch in page component,High,https://nextjs.org/docs/app/building-your-application/routing/error-handling
|
||||||
|
7,Rendering,Use Server Components by default,Server Components reduce client JS bundle,Keep components server by default,Add 'use client' unnecessarily,export default function Page(),('use client') for static content,High,https://nextjs.org/docs/app/building-your-application/rendering/server-components
|
||||||
|
8,Rendering,Mark Client Components explicitly,'use client' for interactive components,Add 'use client' only when needed,Server Component with hooks/events,('use client') for onClick useState,No directive with useState,High,https://nextjs.org/docs/app/building-your-application/rendering/client-components
|
||||||
|
9,Rendering,Push Client Components down,Keep Client Components as leaf nodes,Client wrapper for interactive parts only,Mark page as Client Component,<InteractiveButton/> in Server Page,('use client') on page.tsx,High,
|
||||||
|
10,Rendering,Use streaming for better UX,Stream content with Suspense boundaries,Suspense for slow data fetches,Wait for all data before render,<Suspense><SlowComponent/></Suspense>,await allData then render,Medium,https://nextjs.org/docs/app/building-your-application/routing/loading-ui-and-streaming
|
||||||
|
11,Rendering,Choose correct rendering strategy,SSG for static SSR for dynamic ISR for semi-static,generateStaticParams for known paths,SSR for static content,export const revalidate = 3600,fetch without cache config,Medium,
|
||||||
|
12,DataFetching,Fetch data in Server Components,Fetch directly in async Server Components,async function Page() { const data = await fetch() },useEffect for initial data,const data = await fetch(url),useEffect(() => fetch(url)),High,https://nextjs.org/docs/app/building-your-application/data-fetching
|
||||||
|
13,DataFetching,Configure caching explicitly (Next.js 15+),Next.js 15 changed defaults to uncached for fetch,Explicitly set cache: 'force-cache' for static data,Assume default is cached (it's not in Next.js 15),fetch(url { cache: 'force-cache' }),fetch(url) // Uncached in v15,High,https://nextjs.org/docs/app/building-your-application/upgrading/version-15
|
||||||
|
14,DataFetching,Deduplicate fetch requests,React and Next.js dedupe same requests,Same fetch call in multiple components,Manual request deduplication,Multiple components fetch same URL,Custom cache layer,Low,
|
||||||
|
15,DataFetching,Use Server Actions for mutations,Server Actions for form submissions,action={serverAction} in forms,API route for every mutation,<form action={createPost}>,<form onSubmit={callApiRoute}>,Medium,https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions-and-mutations
|
||||||
|
16,DataFetching,Revalidate data appropriately,Use revalidatePath/revalidateTag after mutations,Revalidate after Server Action,'use client' with manual refetch,revalidatePath('/posts'),router.refresh() everywhere,Medium,https://nextjs.org/docs/app/building-your-application/caching#revalidating
|
||||||
|
17,Images,Use next/image for optimization,Automatic image optimization and lazy loading,<Image> component for all images,<img> tags directly,<Image src={} alt={} width={} height={}>,<img src={}/>,High,https://nextjs.org/docs/app/building-your-application/optimizing/images
|
||||||
|
18,Images,Provide width and height,Prevent layout shift with dimensions,width and height props or fill,Missing dimensions,<Image width={400} height={300}/>,<Image src={url}/>,High,
|
||||||
|
19,Images,Use fill for responsive images,Fill container with object-fit,fill prop with relative parent,Fixed dimensions for responsive,"<Image fill className=""object-cover""/>",<Image width={window.width}/>,Medium,
|
||||||
|
20,Images,Configure remote image domains,Whitelist external image sources,remotePatterns in next.config.js,Allow all domains,remotePatterns: [{ hostname: 'cdn.example.com' }],domains: ['*'],High,https://nextjs.org/docs/app/api-reference/components/image#remotepatterns
|
||||||
|
21,Images,Use priority for LCP images,Mark above-fold images as priority,priority prop on hero images,All images with priority,<Image priority src={hero}/>,<Image priority/> on every image,Medium,
|
||||||
|
22,Fonts,Use next/font for fonts,Self-hosted fonts with zero layout shift,next/font/google or next/font/local,External font links,import { Inter } from 'next/font/google',"<link href=""fonts.googleapis.com""/>",Medium,https://nextjs.org/docs/app/building-your-application/optimizing/fonts
|
||||||
|
23,Fonts,Apply font to layout,Set font in root layout for consistency,className on body in layout.tsx,Font in individual pages,<body className={inter.className}>,Each page imports font,Low,
|
||||||
|
24,Fonts,Use variable fonts,Variable fonts reduce bundle size,Single variable font file,Multiple font weights as files,Inter({ subsets: ['latin'] }),Inter_400 Inter_500 Inter_700,Low,
|
||||||
|
25,Metadata,Use generateMetadata for dynamic,Generate metadata based on params,export async function generateMetadata(),Hardcoded metadata everywhere,generateMetadata({ params }),export const metadata = {},Medium,https://nextjs.org/docs/app/building-your-application/optimizing/metadata
|
||||||
|
26,Metadata,Include OpenGraph images,Add OG images for social sharing,opengraph-image.tsx or og property,Missing social preview images,opengraph: { images: ['/og.png'] },No OG configuration,Medium,
|
||||||
|
27,Metadata,Use metadata API,Export metadata object for static metadata,export const metadata = {},Manual head tags,export const metadata = { title: 'Page' },<head><title>Page</title></head>,Medium,
|
||||||
|
28,API,Use Route Handlers for APIs,app/api routes for API endpoints,app/api/users/route.ts,pages/api for new projects,export async function GET(request),export default function handler,Medium,https://nextjs.org/docs/app/building-your-application/routing/route-handlers
|
||||||
|
29,API,Return proper Response objects,Use NextResponse for API responses,NextResponse.json() for JSON,Plain objects or res.json(),return NextResponse.json({ data }),return { data },Medium,
|
||||||
|
30,API,Handle HTTP methods explicitly,Export named functions for methods,Export GET POST PUT DELETE,Single handler for all methods,export async function POST(),switch(req.method),Low,
|
||||||
|
31,API,Validate request body,Validate input before processing,Zod or similar for validation,Trust client input,const body = schema.parse(await req.json()),const body = await req.json(),High,
|
||||||
|
32,Middleware,Use middleware for auth,Protect routes with middleware.ts,middleware.ts at root,Auth check in every page,export function middleware(request),if (!session) redirect in page,Medium,https://nextjs.org/docs/app/building-your-application/routing/middleware
|
||||||
|
33,Middleware,Match specific paths,Configure middleware matcher,config.matcher for specific routes,Run middleware on all routes,matcher: ['/dashboard/:path*'],No matcher config,Medium,
|
||||||
|
34,Middleware,Keep middleware edge-compatible,Middleware runs on Edge runtime,Edge-compatible code only,Node.js APIs in middleware,Edge-compatible auth check,fs.readFile in middleware,High,
|
||||||
|
35,Environment,Use NEXT_PUBLIC prefix,Client-accessible env vars need prefix,NEXT_PUBLIC_ for client vars,Server vars exposed to client,NEXT_PUBLIC_API_URL,API_SECRET in client code,High,https://nextjs.org/docs/app/building-your-application/configuring/environment-variables
|
||||||
|
36,Environment,Validate env vars,Check required env vars exist,Validate on startup,Undefined env at runtime,if (!process.env.DATABASE_URL) throw,process.env.DATABASE_URL (might be undefined),High,
|
||||||
|
37,Environment,Use .env.local for secrets,Local env file for development secrets,.env.local gitignored,Secrets in .env committed,.env.local with secrets,.env with DATABASE_PASSWORD,High,
|
||||||
|
38,Performance,Analyze bundle size,Use @next/bundle-analyzer,Bundle analyzer in dev,Ship large bundles blindly,ANALYZE=true npm run build,No bundle analysis,Medium,https://nextjs.org/docs/app/building-your-application/optimizing/bundle-analyzer
|
||||||
|
39,Performance,Use dynamic imports,Code split with next/dynamic,dynamic() for heavy components,Import everything statically,const Chart = dynamic(() => import('./Chart')),import Chart from './Chart',Medium,https://nextjs.org/docs/app/building-your-application/optimizing/lazy-loading
|
||||||
|
40,Performance,Avoid layout shifts,Reserve space for dynamic content,Skeleton loaders aspect ratios,Content popping in,"<Skeleton className=""h-48""/>",No placeholder for async content,High,
|
||||||
|
41,Performance,Use Partial Prerendering,Combine static and dynamic in one route,Static shell with Suspense holes,Full dynamic or static pages,Static header + dynamic content,Entire page SSR,Low,https://nextjs.org/docs/app/building-your-application/rendering/partial-prerendering
|
||||||
|
42,Link,Use next/link for navigation,Client-side navigation with prefetching,"<Link href=""""> for internal links",<a> for internal navigation,"<Link href=""/about"">About</Link>","<a href=""/about"">About</a>",High,https://nextjs.org/docs/app/api-reference/components/link
|
||||||
|
43,Link,Prefetch strategically,Control prefetching behavior,prefetch={false} for low-priority,Prefetch all links,<Link prefetch={false}>,Default prefetch on every link,Low,
|
||||||
|
44,Link,Use scroll option appropriately,Control scroll behavior on navigation,scroll={false} for tabs pagination,Always scroll to top,<Link scroll={false}>,Manual scroll management,Low,
|
||||||
|
45,Config,Use next.config.js correctly,Configure Next.js behavior,Proper config options,Deprecated or wrong options,images: { remotePatterns: [] },images: { domains: [] },Medium,https://nextjs.org/docs/app/api-reference/next-config-js
|
||||||
|
46,Config,Enable strict mode,Catch potential issues early,reactStrictMode: true,Strict mode disabled,reactStrictMode: true,reactStrictMode: false,Medium,
|
||||||
|
47,Config,Configure redirects and rewrites,Use config for URL management,redirects() rewrites() in config,Manual redirect handling,redirects: async () => [...],res.redirect in pages,Medium,https://nextjs.org/docs/app/api-reference/next-config-js/redirects
|
||||||
|
48,Deployment,Use Vercel for easiest deploy,Vercel optimized for Next.js,Deploy to Vercel,Self-host without knowledge,vercel deploy,Complex Docker setup for simple app,Low,https://nextjs.org/docs/app/building-your-application/deploying
|
||||||
|
49,Deployment,Configure output for self-hosting,Set output option for deployment target,output: 'standalone' for Docker,Default output for containers,output: 'standalone',No output config for Docker,Medium,https://nextjs.org/docs/app/building-your-application/deploying#self-hosting
|
||||||
|
50,Security,Sanitize user input,Never trust user input,Escape sanitize validate all input,Direct interpolation of user data,DOMPurify.sanitize(userInput),dangerouslySetInnerHTML={{ __html: userInput }},High,
|
||||||
|
51,Security,Use CSP headers,Content Security Policy for XSS protection,Configure CSP in next.config.js,No security headers,headers() with CSP,No CSP configuration,High,https://nextjs.org/docs/app/building-your-application/configuring/content-security-policy
|
||||||
|
52,Security,Validate Server Action input,Server Actions are public endpoints,Validate and authorize in Server Action,Trust Server Action input,Auth check + validation in action,Direct database call without check,High,
|
||||||
|
51
.claude/skills/ui-ux-pro-max/data/stacks/nuxt-ui.csv
Normal file
51
.claude/skills/ui-ux-pro-max/data/stacks/nuxt-ui.csv
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Installation,Add Nuxt UI module,Install and configure Nuxt UI in your Nuxt project,pnpm add @nuxt/ui and add to modules,Manual component imports,"modules: ['@nuxt/ui']","import { UButton } from '@nuxt/ui'",High,https://ui.nuxt.com/docs/getting-started/installation/nuxt
|
||||||
|
2,Installation,Import Tailwind and Nuxt UI CSS,Required CSS imports in main.css file,@import tailwindcss and @import @nuxt/ui,Skip CSS imports,"@import ""tailwindcss""; @import ""@nuxt/ui"";",No CSS imports,High,https://ui.nuxt.com/docs/getting-started/installation/nuxt
|
||||||
|
3,Installation,Wrap app with UApp component,UApp provides global configs for Toast Tooltip and overlays,<UApp> wrapper in app.vue,Skip UApp wrapper,<UApp><NuxtPage/></UApp>,<NuxtPage/> without wrapper,High,https://ui.nuxt.com/docs/components/app
|
||||||
|
4,Components,Use U prefix for components,All Nuxt UI components use U prefix by default,UButton UInput UModal,Button Input Modal,<UButton>Click</UButton>,<Button>Click</Button>,Medium,https://ui.nuxt.com/docs/getting-started/installation/nuxt
|
||||||
|
5,Components,Use semantic color props,Use semantic colors like primary secondary error,color="primary" color="error",Hardcoded colors,"<UButton color=""primary"">","<UButton class=""bg-green-500"">",Medium,https://ui.nuxt.com/docs/getting-started/theme/design-system
|
||||||
|
6,Components,Use variant prop for styling,Nuxt UI provides solid outline soft subtle ghost link variants,variant="soft" variant="outline",Custom button classes,"<UButton variant=""soft"">","<UButton class=""border bg-transparent"">",Medium,https://ui.nuxt.com/docs/components/button
|
||||||
|
7,Components,Use size prop consistently,Components support xs sm md lg xl sizes,size="sm" size="lg",Arbitrary sizing classes,"<UButton size=""lg"">","<UButton class=""text-xl px-6"">",Low,https://ui.nuxt.com/docs/components/button
|
||||||
|
8,Icons,Use icon prop with Iconify format,Nuxt UI supports Iconify icons via icon prop,icon="lucide:home" icon="heroicons:user",i-lucide-home format,"<UButton icon=""lucide:home"">","<UButton icon=""i-lucide-home"">",Medium,https://ui.nuxt.com/docs/getting-started/integrations/icons/nuxt
|
||||||
|
9,Icons,Use leadingIcon and trailingIcon,Position icons with dedicated props for clarity,leadingIcon="lucide:plus" trailingIcon="lucide:arrow-right",Manual icon positioning,"<UButton leadingIcon=""lucide:plus"">","<UButton><Icon name=""lucide:plus""/>Add</UButton>",Low,https://ui.nuxt.com/docs/components/button
|
||||||
|
10,Theming,Configure colors in app.config.ts,Runtime color configuration without restart,ui.colors.primary in app.config.ts,Hardcoded colors in components,"defineAppConfig({ ui: { colors: { primary: 'blue' } } })","<UButton class=""bg-blue-500"">",High,https://ui.nuxt.com/docs/getting-started/theme/design-system
|
||||||
|
11,Theming,Use @theme directive for custom colors,Define design tokens in CSS with Tailwind @theme,@theme { --color-brand-500: #xxx },Inline color definitions,@theme { --color-brand-500: #ef4444; },:style="{ color: '#ef4444' }",Medium,https://ui.nuxt.com/docs/getting-started/theme/design-system
|
||||||
|
12,Theming,Extend semantic colors in nuxt.config,Register new colors like tertiary in theme.colors,theme.colors array in ui config,Use undefined colors,"ui: { theme: { colors: ['primary', 'tertiary'] } }","<UButton color=""tertiary""> without config",Medium,https://ui.nuxt.com/docs/getting-started/theme/design-system
|
||||||
|
13,Forms,Use UForm with schema validation,UForm supports Zod Yup Joi Valibot schemas,:schema prop with validation schema,Manual form validation,"<UForm :schema=""schema"" :state=""state"">",Manual @blur validation,High,https://ui.nuxt.com/docs/components/form
|
||||||
|
14,Forms,Use UFormField for field wrapper,Provides label error message and validation display,UFormField with name prop,Manual error handling,"<UFormField name=""email"" label=""Email"">",<div><label>Email</label><UInput/><span>error</span></div>,Medium,https://ui.nuxt.com/docs/components/form-field
|
||||||
|
15,Forms,Handle form submit with @submit,UForm emits submit event with validated data,@submit handler on UForm,@click on submit button,"<UForm @submit=""onSubmit"">","<UButton @click=""onSubmit"">",Medium,https://ui.nuxt.com/docs/components/form
|
||||||
|
16,Forms,Use validateOn prop for validation timing,Control when validation triggers (blur change input),validateOn="['blur']" for performance,Always validate on input,"<UForm :validateOn=""['blur', 'change']"">","<UForm> (validates on every keystroke)",Low,https://ui.nuxt.com/docs/components/form
|
||||||
|
17,Overlays,Use v-model:open for overlay control,Modal Slideover Drawer use v-model:open,v-model:open for controlled state,Manual show/hide logic,"<UModal v-model:open=""isOpen"">",<UModal v-if="isOpen">,Medium,https://ui.nuxt.com/docs/components/modal
|
||||||
|
18,Overlays,Use useOverlay composable for programmatic overlays,Open overlays programmatically without template refs,useOverlay().open(MyModal),Template ref and manual control,"const overlay = useOverlay(); overlay.open(MyModal, { props })","const modal = ref(); modal.value.open()",Medium,https://ui.nuxt.com/docs/components/modal
|
||||||
|
19,Overlays,Use title and description props,Built-in header support for overlays,title="Confirm" description="Are you sure?",Manual header content,"<UModal title=""Confirm"" description=""Are you sure?"">","<UModal><template #header><h2>Confirm</h2></template>",Low,https://ui.nuxt.com/docs/components/modal
|
||||||
|
20,Dashboard,Use UDashboardSidebar for navigation,Provides collapsible resizable sidebar with mobile support,UDashboardSidebar with header default footer slots,Custom sidebar implementation,<UDashboardSidebar><template #header>...</template></UDashboardSidebar>,<aside class="w-64 border-r">,Medium,https://ui.nuxt.com/docs/components/dashboard-sidebar
|
||||||
|
21,Dashboard,Use UDashboardGroup for layout,Wraps dashboard components with sidebar state management,UDashboardGroup > UDashboardSidebar + UDashboardPanel,Manual layout flex containers,<UDashboardGroup><UDashboardSidebar/><UDashboardPanel/></UDashboardGroup>,"<div class=""flex""><aside/><main/></div>",Medium,https://ui.nuxt.com/docs/components/dashboard-group
|
||||||
|
22,Dashboard,Use UDashboardNavbar for top navigation,Responsive navbar with mobile menu support,UDashboardNavbar in dashboard layout,Custom navbar implementation,<UDashboardNavbar :links="navLinks"/>,<nav class="border-b">,Low,https://ui.nuxt.com/docs/components/dashboard-navbar
|
||||||
|
23,Tables,Use UTable with data and columns props,Powered by TanStack Table with built-in features,:data and :columns props,Manual table markup,"<UTable :data=""users"" :columns=""columns""/>","<table><tr v-for=""user in users"">",High,https://ui.nuxt.com/docs/components/table
|
||||||
|
24,Tables,Define columns with accessorKey,Column definitions use accessorKey for data binding,accessorKey: 'email' in column def,String column names only,"{ accessorKey: 'email', header: 'Email' }","['name', 'email']",Medium,https://ui.nuxt.com/docs/components/table
|
||||||
|
25,Tables,Use cell slot for custom rendering,Customize cell content with scoped slots,#cell-columnName slot,Override entire table,<template #cell-status="{ row }">,Manual column render function,Medium,https://ui.nuxt.com/docs/components/table
|
||||||
|
26,Tables,Enable sorting with sortable column option,Add sortable: true to column definition,sortable: true in column,Manual sort implementation,"{ accessorKey: 'name', sortable: true }",@click="sortBy('name')",Low,https://ui.nuxt.com/docs/components/table
|
||||||
|
27,Navigation,Use UNavigationMenu for nav links,Horizontal or vertical navigation with dropdown support,UNavigationMenu with items array,Manual nav with v-for,"<UNavigationMenu :items=""navItems""/>","<nav><a v-for=""item in items"">",Medium,https://ui.nuxt.com/docs/components/navigation-menu
|
||||||
|
28,Navigation,Use UBreadcrumb for page hierarchy,Automatic breadcrumb with NuxtLink support,:items array with label and to,Manual breadcrumb links,"<UBreadcrumb :items=""breadcrumbs""/>","<nav><span v-for=""crumb in crumbs"">",Low,https://ui.nuxt.com/docs/components/breadcrumb
|
||||||
|
29,Navigation,Use UTabs for tabbed content,Tab navigation with content panels,UTabs with items containing slot content,Manual tab state,"<UTabs :items=""tabs""/>","<div><button @click=""tab=1"">",Medium,https://ui.nuxt.com/docs/components/tabs
|
||||||
|
30,Feedback,Use useToast for notifications,Composable for toast notifications,useToast().add({ title description }),Alert components for toasts,"const toast = useToast(); toast.add({ title: 'Saved' })",<UAlert v-if="showSuccess">,High,https://ui.nuxt.com/docs/components/toast
|
||||||
|
31,Feedback,Use UAlert for inline messages,Static alert messages with icon and actions,UAlert with title description color,Toast for static messages,"<UAlert title=""Warning"" color=""warning""/>",useToast for inline alerts,Medium,https://ui.nuxt.com/docs/components/alert
|
||||||
|
32,Feedback,Use USkeleton for loading states,Placeholder content during data loading,USkeleton with appropriate size,Spinner for content loading,<USkeleton class="h-4 w-32"/>,<UIcon name="lucide:loader" class="animate-spin"/>,Low,https://ui.nuxt.com/docs/components/skeleton
|
||||||
|
33,Color Mode,Use UColorModeButton for theme toggle,Built-in light/dark mode toggle button,UColorModeButton component,Manual color mode logic,<UColorModeButton/>,"<button @click=""toggleColorMode"">",Low,https://ui.nuxt.com/docs/components/color-mode-button
|
||||||
|
34,Color Mode,Use UColorModeSelect for theme picker,Dropdown to select system light or dark mode,UColorModeSelect component,Custom select for theme,<UColorModeSelect/>,"<USelect v-model=""colorMode"" :items=""modes""/>",Low,https://ui.nuxt.com/docs/components/color-mode-select
|
||||||
|
35,Customization,Use ui prop for component styling,Override component styles via ui prop,ui prop with slot class overrides,Global CSS overrides,"<UButton :ui=""{ base: 'rounded-full' }""/>",<UButton class="!rounded-full"/>,Medium,https://ui.nuxt.com/docs/getting-started/theme/components
|
||||||
|
36,Customization,Configure default variants in nuxt.config,Set default color and size for all components,theme.defaultVariants in ui config,Repeat props on every component,"ui: { theme: { defaultVariants: { color: 'neutral' } } }","<UButton color=""neutral""> everywhere",Medium,https://ui.nuxt.com/docs/getting-started/installation/nuxt
|
||||||
|
37,Customization,Use app.config.ts for theme overrides,Runtime theme customization,defineAppConfig with ui key,nuxt.config for runtime values,"defineAppConfig({ ui: { button: { defaultVariants: { size: 'sm' } } } })","nuxt.config ui.button.size: 'sm'",Medium,https://ui.nuxt.com/docs/getting-started/theme/components
|
||||||
|
38,Performance,Enable component detection,Tree-shake unused component CSS,experimental.componentDetection: true,Include all component CSS,"ui: { experimental: { componentDetection: true } }","ui: {} (includes all CSS)",Low,https://ui.nuxt.com/docs/getting-started/installation/nuxt
|
||||||
|
39,Performance,Use UTable virtualize for large data,Enable virtualization for 1000+ rows,:virtualize prop on UTable,Render all rows,"<UTable :data=""largeData"" virtualize/>","<UTable :data=""largeData""/>",Medium,https://ui.nuxt.com/docs/components/table
|
||||||
|
40,Accessibility,Use semantic component props,Components have built-in ARIA support,Use title description label props,Skip accessibility props,"<UModal title=""Settings"">","<UModal><h2>Settings</h2>",Medium,https://ui.nuxt.com/docs/components/modal
|
||||||
|
41,Accessibility,Use UFormField for form accessibility,Automatic label-input association,UFormField wraps inputs,Manual id and for attributes,"<UFormField label=""Email""><UInput/></UFormField>","<label for=""email"">Email</label><UInput id=""email""/>",High,https://ui.nuxt.com/docs/components/form-field
|
||||||
|
42,Content,Use UContentToc for table of contents,Automatic TOC with active heading highlight,UContentToc with :links,Manual TOC implementation,"<UContentToc :links=""toc""/>","<nav><a v-for=""heading in headings"">",Low,https://ui.nuxt.com/docs/components/content-toc
|
||||||
|
43,Content,Use UContentSearch for docs search,Command palette for documentation search,UContentSearch with Nuxt Content,Custom search implementation,<UContentSearch/>,<UCommandPalette :groups="searchResults"/>,Low,https://ui.nuxt.com/docs/components/content-search
|
||||||
|
44,AI/Chat,Use UChatMessages for chat UI,Designed for Vercel AI SDK integration,UChatMessages with messages array,Custom chat message list,"<UChatMessages :messages=""messages""/>","<div v-for=""msg in messages"">",Medium,https://ui.nuxt.com/docs/components/chat-messages
|
||||||
|
45,AI/Chat,Use UChatPrompt for input,Enhanced textarea for AI prompts,UChatPrompt with v-model,Basic textarea,<UChatPrompt v-model="prompt"/>,<UTextarea v-model="prompt"/>,Medium,https://ui.nuxt.com/docs/components/chat-prompt
|
||||||
|
46,Editor,Use UEditor for rich text,TipTap-based editor with toolbar support,UEditor with v-model:content,Custom TipTap setup,"<UEditor v-model:content=""content""/>",Manual TipTap initialization,Medium,https://ui.nuxt.com/docs/components/editor
|
||||||
|
47,Links,Use to prop for navigation,UButton and ULink support NuxtLink to prop,to="/dashboard" for internal links,href for internal navigation,"<UButton to=""/dashboard"">","<UButton href=""/dashboard"">",Medium,https://ui.nuxt.com/docs/components/button
|
||||||
|
48,Links,Use external prop for outside links,Explicitly mark external links,target="_blank" with external URLs,Forget rel="noopener","<UButton to=""https://example.com"" target=""_blank"">","<UButton href=""https://..."">",Low,https://ui.nuxt.com/docs/components/link
|
||||||
|
49,Loading,Use loadingAuto on buttons,Automatic loading state from @click promise,loadingAuto prop on UButton,Manual loading state,"<UButton loadingAuto @click=""async () => await save()"">","<UButton :loading=""isLoading"" @click=""save"">",Low,https://ui.nuxt.com/docs/components/button
|
||||||
|
50,Loading,Use UForm loadingAuto,Auto-disable form during submit,loadingAuto on UForm (default true),Manual form disabled state,"<UForm @submit=""handleSubmit"">","<UForm :disabled=""isSubmitting"">",Low,https://ui.nuxt.com/docs/components/form
|
||||||
|
Can't render this file because it contains an unexpected character in line 6 and column 94.
|
59
.claude/skills/ui-ux-pro-max/data/stacks/nuxtjs.csv
Normal file
59
.claude/skills/ui-ux-pro-max/data/stacks/nuxtjs.csv
Normal file
@ -0,0 +1,59 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Routing,Use file-based routing,Create routes by adding files in pages directory,pages/ directory with index.vue,Manual route configuration,pages/dashboard/index.vue,Custom router setup,Medium,https://nuxt.com/docs/getting-started/routing
|
||||||
|
2,Routing,Use dynamic route parameters,Create dynamic routes with bracket syntax,[id].vue for dynamic params,Hardcoded routes for dynamic content,pages/posts/[id].vue,pages/posts/post1.vue,Medium,https://nuxt.com/docs/getting-started/routing
|
||||||
|
3,Routing,Use catch-all routes,Handle multiple path segments with [...slug],[...slug].vue for catch-all,Multiple nested dynamic routes,pages/[...slug].vue,pages/[a]/[b]/[c].vue,Low,https://nuxt.com/docs/getting-started/routing
|
||||||
|
4,Routing,Define page metadata with definePageMeta,Set page-level configuration and middleware,definePageMeta for layout middleware title,Manual route meta configuration,"definePageMeta({ layout: 'admin', middleware: 'auth' })",router.beforeEach for page config,High,https://nuxt.com/docs/api/utils/define-page-meta
|
||||||
|
5,Routing,Use validate for route params,Validate dynamic route parameters before rendering,validate function in definePageMeta,Manual validation in setup,"definePageMeta({ validate: (route) => /^\d+$/.test(route.params.id) })",if (!valid) navigateTo('/404'),Medium,https://nuxt.com/docs/api/utils/define-page-meta
|
||||||
|
6,Rendering,Use SSR by default,Server-side rendering is enabled by default,Keep ssr: true (default),Disable SSR unnecessarily,ssr: true (default),ssr: false for all pages,High,https://nuxt.com/docs/guide/concepts/rendering
|
||||||
|
7,Rendering,Use .client suffix for client-only components,Mark components to render only on client,ComponentName.client.vue suffix,v-if with process.client check,Comments.client.vue,<div v-if="process.client"><Comments/></div>,Medium,https://nuxt.com/docs/guide/directory-structure/components
|
||||||
|
8,Rendering,Use .server suffix for server-only components,Mark components to render only on server,ComponentName.server.vue suffix,Manual server check,HeavyMarkdown.server.vue,v-if="process.server",Low,https://nuxt.com/docs/guide/directory-structure/components
|
||||||
|
9,DataFetching,Use useFetch for simple data fetching,Wrapper around useAsyncData for URL fetching,useFetch for API calls,$fetch in onMounted,"const { data } = await useFetch('/api/posts')","onMounted(async () => { data.value = await $fetch('/api/posts') })",High,https://nuxt.com/docs/api/composables/use-fetch
|
||||||
|
10,DataFetching,Use useAsyncData for complex fetching,Fine-grained control over async data,useAsyncData for CMS or custom fetching,useFetch for non-URL data sources,"const { data } = await useAsyncData('posts', () => cms.getPosts())","const { data } = await useFetch(() => cms.getPosts())",Medium,https://nuxt.com/docs/api/composables/use-async-data
|
||||||
|
11,DataFetching,Use $fetch for non-reactive requests,$fetch for event handlers and non-component code,$fetch in event handlers or server routes,useFetch in click handlers,"async function submit() { await $fetch('/api/submit', { method: 'POST' }) }","async function submit() { await useFetch('/api/submit') }",High,https://nuxt.com/docs/api/utils/dollarfetch
|
||||||
|
12,DataFetching,Use lazy option for non-blocking fetch,Defer data fetching for better initial load,lazy: true for below-fold content,Blocking fetch for non-critical data,"useFetch('/api/comments', { lazy: true })",await useFetch('/api/comments') for footer,Medium,https://nuxt.com/docs/api/composables/use-fetch
|
||||||
|
13,DataFetching,Use server option to control fetch location,Choose where data is fetched,server: false for client-only data,Server fetch for user-specific client data,"useFetch('/api/user-preferences', { server: false })",useFetch for localStorage-dependent data,Medium,https://nuxt.com/docs/api/composables/use-fetch
|
||||||
|
14,DataFetching,Use pick to reduce payload size,Select only needed fields from response,pick option for large responses,Fetching entire objects when few fields needed,"useFetch('/api/user', { pick: ['id', 'name'] })",useFetch('/api/user') then destructure,Low,https://nuxt.com/docs/api/composables/use-fetch
|
||||||
|
15,DataFetching,Use transform for data manipulation,Transform data before storing in state,transform option for data shaping,Manual transformation after fetch,"useFetch('/api/posts', { transform: (posts) => posts.map(p => p.title) })",const titles = data.value.map(p => p.title),Low,https://nuxt.com/docs/api/composables/use-fetch
|
||||||
|
16,DataFetching,Handle loading and error states,Always handle pending and error states,Check status pending error refs,Ignoring loading states,"<div v-if=""status === 'pending'"">Loading...</div>",No loading indicator,High,https://nuxt.com/docs/getting-started/data-fetching
|
||||||
|
17,Lifecycle,Avoid side effects in script setup root,Move side effects to lifecycle hooks,Side effects in onMounted,setInterval in root script setup,"onMounted(() => { interval = setInterval(...) })","<script setup>setInterval(...)</script>",High,https://nuxt.com/docs/guide/concepts/nuxt-lifecycle
|
||||||
|
18,Lifecycle,Use onMounted for DOM access,Access DOM only after component is mounted,onMounted for DOM manipulation,Direct DOM access in setup,"onMounted(() => { document.getElementById('el') })","<script setup>document.getElementById('el')</script>",High,https://nuxt.com/docs/api/composables/on-mounted
|
||||||
|
19,Lifecycle,Use nextTick for post-render access,Wait for DOM updates before accessing elements,await nextTick() after state changes,Immediate DOM access after state change,"count.value++; await nextTick(); el.value.focus()","count.value++; el.value.focus()",Medium,https://nuxt.com/docs/api/utils/next-tick
|
||||||
|
20,Lifecycle,Use onPrehydrate for pre-hydration logic,Run code before Nuxt hydrates the page,onPrehydrate for client setup,onMounted for hydration-critical code,"onPrehydrate(() => { console.log(window) })",onMounted for pre-hydration needs,Low,https://nuxt.com/docs/api/composables/on-prehydrate
|
||||||
|
21,Server,Use server/api for API routes,Create API endpoints in server/api directory,server/api/users.ts for /api/users,Manual Express setup,server/api/hello.ts -> /api/hello,app.get('/api/hello'),High,https://nuxt.com/docs/guide/directory-structure/server
|
||||||
|
22,Server,Use defineEventHandler for handlers,Define server route handlers,defineEventHandler for all handlers,export default function,"export default defineEventHandler((event) => { return { hello: 'world' } })","export default function(req, res) {}",High,https://nuxt.com/docs/guide/directory-structure/server
|
||||||
|
23,Server,Use server/routes for non-api routes,Routes without /api prefix,server/routes for custom paths,server/api for non-api routes,server/routes/sitemap.xml.ts,server/api/sitemap.xml.ts,Medium,https://nuxt.com/docs/guide/directory-structure/server
|
||||||
|
24,Server,Use getQuery and readBody for input,Access query params and request body,getQuery(event) readBody(event),Direct event access,"const { id } = getQuery(event)",event.node.req.query,Medium,https://nuxt.com/docs/guide/directory-structure/server
|
||||||
|
25,Server,Validate server input,Always validate input in server handlers,Zod or similar for validation,Trust client input,"const body = await readBody(event); schema.parse(body)",const body = await readBody(event),High,https://nuxt.com/docs/guide/directory-structure/server
|
||||||
|
26,State,Use useState for shared reactive state,SSR-friendly shared state across components,useState for cross-component state,ref for shared state,"const count = useState('count', () => 0)",const count = ref(0) in composable,High,https://nuxt.com/docs/api/composables/use-state
|
||||||
|
27,State,Use unique keys for useState,Prevent state conflicts with unique keys,Descriptive unique keys for each state,Generic or duplicate keys,"useState('user-preferences', () => ({}))",useState('data') in multiple places,Medium,https://nuxt.com/docs/api/composables/use-state
|
||||||
|
28,State,Use Pinia for complex state,Pinia for advanced state management,@pinia/nuxt for complex apps,Custom state management,useMainStore() with Pinia,Custom reactive store implementation,Medium,https://nuxt.com/docs/getting-started/state-management
|
||||||
|
29,State,Use callOnce for one-time async operations,Ensure async operations run only once,callOnce for store initialization,Direct await in component,"await callOnce(store.fetch)",await store.fetch() on every render,Medium,https://nuxt.com/docs/api/utils/call-once
|
||||||
|
30,SEO,Use useSeoMeta for SEO tags,Type-safe SEO meta tag management,useSeoMeta for meta tags,useHead for simple meta,"useSeoMeta({ title: 'Home', ogTitle: 'Home', description: '...' })","useHead({ meta: [{ name: 'description', content: '...' }] })",High,https://nuxt.com/docs/api/composables/use-seo-meta
|
||||||
|
31,SEO,Use reactive values in useSeoMeta,Dynamic SEO tags with refs or getters,Computed getters for dynamic values,Static values for dynamic content,"useSeoMeta({ title: () => post.value.title })","useSeoMeta({ title: post.value.title })",Medium,https://nuxt.com/docs/api/composables/use-seo-meta
|
||||||
|
32,SEO,Use useHead for non-meta head elements,Scripts styles links in head,useHead for scripts and links,useSeoMeta for scripts,"useHead({ script: [{ src: '/analytics.js' }] })","useSeoMeta({ script: '...' })",Medium,https://nuxt.com/docs/api/composables/use-head
|
||||||
|
33,SEO,Include OpenGraph tags,Add OG tags for social sharing,ogTitle ogDescription ogImage,Missing social preview,"useSeoMeta({ ogImage: '/og.png', twitterCard: 'summary_large_image' })",No OG configuration,Medium,https://nuxt.com/docs/api/composables/use-seo-meta
|
||||||
|
34,Middleware,Use defineNuxtRouteMiddleware,Define route middleware properly,defineNuxtRouteMiddleware wrapper,export default function,"export default defineNuxtRouteMiddleware((to, from) => {})","export default function(to, from) {}",High,https://nuxt.com/docs/guide/directory-structure/middleware
|
||||||
|
35,Middleware,Use navigateTo for redirects,Redirect in middleware with navigateTo,return navigateTo('/login'),router.push in middleware,"if (!auth) return navigateTo('/login')","if (!auth) router.push('/login')",High,https://nuxt.com/docs/api/utils/navigate-to
|
||||||
|
36,Middleware,Reference middleware in definePageMeta,Apply middleware to specific pages,middleware array in definePageMeta,Global middleware for page-specific,definePageMeta({ middleware: ['auth'] }),Global auth check for one page,Medium,https://nuxt.com/docs/guide/directory-structure/middleware
|
||||||
|
37,Middleware,Use .global suffix for global middleware,Apply middleware to all routes,auth.global.ts for app-wide auth,Manual middleware on every page,middleware/auth.global.ts,middleware: ['auth'] on every page,Medium,https://nuxt.com/docs/guide/directory-structure/middleware
|
||||||
|
38,ErrorHandling,Use createError for errors,Create errors with proper status codes,createError with statusCode,throw new Error,"throw createError({ statusCode: 404, statusMessage: 'Not Found' })",throw new Error('Not Found'),High,https://nuxt.com/docs/api/utils/create-error
|
||||||
|
39,ErrorHandling,Use NuxtErrorBoundary for local errors,Handle errors within component subtree,NuxtErrorBoundary for component errors,Global error page for local errors,"<NuxtErrorBoundary @error=""log""><template #error=""{ error }"">",error.vue for component errors,Medium,https://nuxt.com/docs/getting-started/error-handling
|
||||||
|
40,ErrorHandling,Use clearError to recover from errors,Clear error state and optionally redirect,clearError({ redirect: '/' }),Manual error state reset,clearError({ redirect: '/home' }),error.value = null,Medium,https://nuxt.com/docs/api/utils/clear-error
|
||||||
|
41,ErrorHandling,Use short statusMessage,Keep statusMessage brief for security,Short generic messages,Detailed error info in statusMessage,"createError({ statusCode: 400, statusMessage: 'Bad Request' })","createError({ statusMessage: 'Invalid user ID: 123' })",High,https://nuxt.com/docs/getting-started/error-handling
|
||||||
|
42,Link,Use NuxtLink for internal navigation,Client-side navigation with prefetching,<NuxtLink to> for internal links,<a href> for internal links,<NuxtLink to="/about">About</NuxtLink>,<a href="/about">About</a>,High,https://nuxt.com/docs/api/components/nuxt-link
|
||||||
|
43,Link,Configure prefetch behavior,Control when prefetching occurs,prefetchOn for interaction-based,Default prefetch for low-priority,"<NuxtLink prefetch-on=""interaction"">",Always default prefetch,Low,https://nuxt.com/docs/api/components/nuxt-link
|
||||||
|
44,Link,Use useRouter for programmatic navigation,Navigate programmatically,useRouter().push() for navigation,Direct window.location,"const router = useRouter(); router.push('/dashboard')",window.location.href = '/dashboard',Medium,https://nuxt.com/docs/api/composables/use-router
|
||||||
|
45,Link,Use navigateTo in composables,Navigate outside components,navigateTo() in middleware or plugins,useRouter in non-component code,return navigateTo('/login'),router.push in middleware,Medium,https://nuxt.com/docs/api/utils/navigate-to
|
||||||
|
46,AutoImports,Leverage auto-imports,Use auto-imported composables directly,Direct use of ref computed useFetch,Manual imports for Nuxt composables,"const count = ref(0)","import { ref } from 'vue'; const count = ref(0)",Medium,https://nuxt.com/docs/guide/concepts/auto-imports
|
||||||
|
47,AutoImports,Use #imports for explicit imports,Explicit imports when needed,#imports for clarity or disabled auto-imports,"import from 'vue' when auto-import enabled","import { ref } from '#imports'","import { ref } from 'vue'",Low,https://nuxt.com/docs/guide/concepts/auto-imports
|
||||||
|
48,AutoImports,Configure third-party auto-imports,Add external package auto-imports,imports.presets in nuxt.config,Manual imports everywhere,"imports: { presets: [{ from: 'vue-i18n', imports: ['useI18n'] }] }",import { useI18n } everywhere,Low,https://nuxt.com/docs/guide/concepts/auto-imports
|
||||||
|
49,Plugins,Use defineNuxtPlugin,Define plugins properly,defineNuxtPlugin wrapper,export default function,"export default defineNuxtPlugin((nuxtApp) => {})","export default function(ctx) {}",High,https://nuxt.com/docs/guide/directory-structure/plugins
|
||||||
|
50,Plugins,Use provide for injection,Provide helpers across app,return { provide: {} } for type safety,nuxtApp.provide without types,"return { provide: { hello: (name) => `Hello ${name}!` } }","nuxtApp.provide('hello', fn)",Medium,https://nuxt.com/docs/guide/directory-structure/plugins
|
||||||
|
51,Plugins,Use .client or .server suffix,Control plugin execution environment,plugin.client.ts for client-only,if (process.client) checks,analytics.client.ts,"if (process.client) { // analytics }",Medium,https://nuxt.com/docs/guide/directory-structure/plugins
|
||||||
|
52,Environment,Use runtimeConfig for env vars,Access environment variables safely,runtimeConfig in nuxt.config,process.env directly,"runtimeConfig: { apiSecret: '', public: { apiBase: '' } }",process.env.API_SECRET in components,High,https://nuxt.com/docs/guide/going-further/runtime-config
|
||||||
|
53,Environment,Use NUXT_ prefix for env override,Override config with environment variables,NUXT_API_SECRET NUXT_PUBLIC_API_BASE,Custom env var names,NUXT_PUBLIC_API_BASE=https://api.example.com,API_BASE=https://api.example.com,High,https://nuxt.com/docs/guide/going-further/runtime-config
|
||||||
|
54,Environment,Access public config with useRuntimeConfig,Get public config in components,useRuntimeConfig().public,Direct process.env access,const config = useRuntimeConfig(); config.public.apiBase,process.env.NUXT_PUBLIC_API_BASE,High,https://nuxt.com/docs/api/composables/use-runtime-config
|
||||||
|
55,Environment,Keep secrets in private config,Server-only secrets in runtimeConfig root,runtimeConfig.apiSecret (server only),Secrets in public config,runtimeConfig: { dbPassword: '' },runtimeConfig: { public: { dbPassword: '' } },High,https://nuxt.com/docs/guide/going-further/runtime-config
|
||||||
|
56,Performance,Use Lazy prefix for code splitting,Lazy load components with Lazy prefix,<LazyComponent> for below-fold,Eager load all components,<LazyMountainsList v-if="show"/>,<MountainsList/> for hidden content,Medium,https://nuxt.com/docs/guide/directory-structure/components
|
||||||
|
57,Performance,Use useLazyFetch for non-blocking data,Alias for useFetch with lazy: true,useLazyFetch for secondary data,useFetch for all requests,"const { data } = useLazyFetch('/api/comments')",await useFetch for comments section,Medium,https://nuxt.com/docs/api/composables/use-lazy-fetch
|
||||||
|
58,Performance,Use lazy hydration for interactivity,Delay component hydration until needed,LazyComponent with hydration strategy,Immediate hydration for all,<LazyModal hydrate-on-visible/>,<Modal/> in footer,Low,https://nuxt.com/docs/guide/going-further/experimental-features
|
||||||
|
Can't render this file because it contains an unexpected character in line 8 and column 193.
|
52
.claude/skills/ui-ux-pro-max/data/stacks/react-native.csv
Normal file
52
.claude/skills/ui-ux-pro-max/data/stacks/react-native.csv
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Components,Use functional components,Hooks-based components are standard,Functional components with hooks,Class components,const App = () => { },class App extends Component,Medium,https://reactnative.dev/docs/intro-react
|
||||||
|
2,Components,Keep components small,Single responsibility principle,Split into smaller components,Large monolithic components,<Header /><Content /><Footer />,500+ line component,Medium,
|
||||||
|
3,Components,Use TypeScript,Type safety for props and state,TypeScript for new projects,JavaScript without types,const Button: FC<Props> = () => { },const Button = (props) => { },Medium,
|
||||||
|
4,Components,Colocate component files,Keep related files together,Component folder with styles,Flat structure,components/Button/index.tsx styles.ts,components/Button.tsx styles/button.ts,Low,
|
||||||
|
5,Styling,Use StyleSheet.create,Optimized style objects,StyleSheet for all styles,Inline style objects,StyleSheet.create({ container: {} }),style={{ margin: 10 }},High,https://reactnative.dev/docs/stylesheet
|
||||||
|
6,Styling,Avoid inline styles,Prevent object recreation,Styles in StyleSheet,Inline style objects in render,style={styles.container},"style={{ margin: 10, padding: 5 }}",Medium,
|
||||||
|
7,Styling,Use flexbox for layout,React Native uses flexbox,flexDirection alignItems justifyContent,Absolute positioning everywhere,flexDirection: 'row',position: 'absolute' everywhere,Medium,https://reactnative.dev/docs/flexbox
|
||||||
|
8,Styling,Handle platform differences,Platform-specific styles,Platform.select or .ios/.android files,Same styles for both platforms,"Platform.select({ ios: {}, android: {} })",Hardcoded iOS values,Medium,https://reactnative.dev/docs/platform-specific-code
|
||||||
|
9,Styling,Use responsive dimensions,Scale for different screens,Dimensions or useWindowDimensions,Fixed pixel values,useWindowDimensions(),width: 375,Medium,
|
||||||
|
10,Navigation,Use React Navigation,Standard navigation library,React Navigation for routing,Manual navigation management,createStackNavigator(),Custom navigation state,Medium,https://reactnavigation.org/
|
||||||
|
11,Navigation,Type navigation params,Type-safe navigation,Typed navigation props,Untyped navigation,"navigation.navigate<RootStackParamList>('Home', { id })","navigation.navigate('Home', { id })",Medium,
|
||||||
|
12,Navigation,Use deep linking,Support URL-based navigation,Configure linking prop,No deep link support,linking: { prefixes: [] },No linking configuration,Medium,https://reactnavigation.org/docs/deep-linking/
|
||||||
|
13,Navigation,Handle back button,Android back button handling,useFocusEffect with BackHandler,Ignore back button,BackHandler.addEventListener,No back handler,High,
|
||||||
|
14,State,Use useState for local state,Simple component state,useState for UI state,Class component state,"const [count, setCount] = useState(0)",this.state = { count: 0 },Medium,
|
||||||
|
15,State,Use useReducer for complex state,Complex state logic,useReducer for related state,Multiple useState for related values,useReducer(reducer initialState),5+ useState calls,Medium,
|
||||||
|
16,State,Use context sparingly,Context for global state,Context for theme auth locale,Context for frequently changing data,ThemeContext for app theme,Context for list item data,Medium,
|
||||||
|
17,State,Consider Zustand or Redux,External state management,Zustand for simple Redux for complex,useState for global state,create((set) => ({ })),Prop drilling global state,Medium,
|
||||||
|
18,Lists,Use FlatList for long lists,Virtualized list rendering,FlatList for 50+ items,ScrollView with map,<FlatList data={items} />,<ScrollView>{items.map()}</ScrollView>,High,https://reactnative.dev/docs/flatlist
|
||||||
|
19,Lists,Provide keyExtractor,Unique keys for list items,keyExtractor with stable ID,Index as key,keyExtractor={(item) => item.id},"keyExtractor={(_, index) => index}",High,
|
||||||
|
20,Lists,Optimize renderItem,Memoize list item components,React.memo for list items,Inline render function,renderItem={({ item }) => <MemoizedItem item={item} />},renderItem={({ item }) => <View>...</View>},High,
|
||||||
|
21,Lists,Use getItemLayout for fixed height,Skip measurement for performance,getItemLayout when height known,Dynamic measurement for fixed items,"getItemLayout={(_, index) => ({ length: 50, offset: 50 * index, index })}",No getItemLayout for fixed height,Medium,
|
||||||
|
22,Lists,Implement windowSize,Control render window,Smaller windowSize for memory,Default windowSize for large lists,windowSize={5},windowSize={21} for huge lists,Medium,
|
||||||
|
23,Performance,Use React.memo,Prevent unnecessary re-renders,memo for pure components,No memoization,export default memo(MyComponent),export default MyComponent,Medium,
|
||||||
|
24,Performance,Use useCallback for handlers,Stable function references,useCallback for props,New function on every render,"useCallback(() => {}, [deps])",() => handlePress(),Medium,
|
||||||
|
25,Performance,Use useMemo for expensive ops,Cache expensive calculations,useMemo for heavy computations,Recalculate every render,"useMemo(() => expensive(), [deps])",const result = expensive(),Medium,
|
||||||
|
26,Performance,Avoid anonymous functions in JSX,Prevent re-renders,Named handlers or useCallback,Inline arrow functions,onPress={handlePress},onPress={() => doSomething()},Medium,
|
||||||
|
27,Performance,Use Hermes engine,Improved startup and memory,Enable Hermes in build,JavaScriptCore for new projects,hermes_enabled: true,hermes_enabled: false,Medium,https://reactnative.dev/docs/hermes
|
||||||
|
28,Images,Use expo-image,Modern performant image component for React Native,"Use expo-image for caching, blurring, and performance",Use default Image for heavy lists or unmaintained libraries,<Image source={url} cachePolicy='memory-disk' /> (expo-image),<FastImage source={url} />,Medium,https://docs.expo.dev/versions/latest/sdk/image/
|
||||||
|
29,Images,Specify image dimensions,Prevent layout shifts,width and height for remote images,No dimensions for network images,<Image style={{ width: 100 height: 100 }} />,<Image source={{ uri }} /> no size,High,
|
||||||
|
30,Images,Use resizeMode,Control image scaling,resizeMode cover contain,Stretch images,"resizeMode=""cover""",No resizeMode,Low,
|
||||||
|
31,Forms,Use controlled inputs,State-controlled form fields,value + onChangeText,Uncontrolled inputs,<TextInput value={text} onChangeText={setText} />,<TextInput defaultValue={text} />,Medium,
|
||||||
|
32,Forms,Handle keyboard,Manage keyboard visibility,KeyboardAvoidingView,Content hidden by keyboard,"<KeyboardAvoidingView behavior=""padding"">",No keyboard handling,High,https://reactnative.dev/docs/keyboardavoidingview
|
||||||
|
33,Forms,Use proper keyboard types,Appropriate keyboard for input,keyboardType for input type,Default keyboard for all,"keyboardType=""email-address""","keyboardType=""default"" for email",Low,
|
||||||
|
34,Touch,Use Pressable,Modern touch handling,Pressable for touch interactions,TouchableOpacity for new code,<Pressable onPress={} />,<TouchableOpacity onPress={} />,Low,https://reactnative.dev/docs/pressable
|
||||||
|
35,Touch,Provide touch feedback,Visual feedback on press,Ripple or opacity change,No feedback on press,android_ripple={{ color: 'gray' }},No press feedback,Medium,
|
||||||
|
36,Touch,Set hitSlop for small targets,Increase touch area,hitSlop for icons and small buttons,Tiny touch targets,hitSlop={{ top: 10 bottom: 10 }},44x44 with no hitSlop,Medium,
|
||||||
|
37,Animation,Use Reanimated,High-performance animations,react-native-reanimated,Animated API for complex,useSharedValue useAnimatedStyle,Animated.timing for gesture,Medium,https://docs.swmansion.com/react-native-reanimated/
|
||||||
|
38,Animation,Run on UI thread,worklets for smooth animation,Run animations on UI thread,JS thread animations,runOnUI(() => {}),Animated on JS thread,High,
|
||||||
|
39,Animation,Use gesture handler,Native gesture recognition,react-native-gesture-handler,JS-based gesture handling,<GestureDetector>,<View onTouchMove={} />,Medium,https://docs.swmansion.com/react-native-gesture-handler/
|
||||||
|
40,Async,Handle loading states,Show loading indicators,ActivityIndicator during load,Empty screen during load,{isLoading ? <ActivityIndicator /> : <Content />},No loading state,Medium,
|
||||||
|
41,Async,Handle errors gracefully,Error boundaries and fallbacks,Error UI for failed requests,Crash on error,{error ? <ErrorView /> : <Content />},No error handling,High,
|
||||||
|
42,Async,Cancel async operations,Cleanup on unmount,AbortController or cleanup,Memory leaks from async,useEffect cleanup,No cleanup for subscriptions,High,
|
||||||
|
43,Accessibility,Add accessibility labels,Describe UI elements,accessibilityLabel for all interactive,Missing labels,"accessibilityLabel=""Submit form""",<Pressable> without label,High,https://reactnative.dev/docs/accessibility
|
||||||
|
44,Accessibility,Use accessibility roles,Semantic meaning,accessibilityRole for elements,Wrong roles,"accessibilityRole=""button""",No role for button,Medium,
|
||||||
|
45,Accessibility,Support screen readers,Test with TalkBack/VoiceOver,Test with screen readers,Skip accessibility testing,Regular TalkBack testing,No screen reader testing,High,
|
||||||
|
46,Testing,Use React Native Testing Library,Component testing,render and fireEvent,Enzyme or manual testing,render(<Component />),shallow(<Component />),Medium,https://callstack.github.io/react-native-testing-library/
|
||||||
|
47,Testing,Test on real devices,Real device behavior,Test on iOS and Android devices,Simulator only,Device testing in CI,Simulator only testing,High,
|
||||||
|
48,Testing,Use Detox for E2E,End-to-end testing,Detox for critical flows,Manual E2E testing,detox test,Manual testing only,Medium,https://wix.github.io/Detox/
|
||||||
|
49,Native,Use native modules carefully,Bridge has overhead,Batch native calls,Frequent bridge crossing,Batch updates,Call native on every keystroke,High,
|
||||||
|
50,Native,Use Expo when possible,Simplified development,Expo for standard features,Bare RN for simple apps,expo install package,react-native link package,Low,https://docs.expo.dev/
|
||||||
|
51,Native,Handle permissions,Request permissions properly,Check and request permissions,Assume permissions granted,PermissionsAndroid.request(),Access without permission check,High,https://reactnative.dev/docs/permissionsandroid
|
||||||
|
54
.claude/skills/ui-ux-pro-max/data/stacks/react.csv
Normal file
54
.claude/skills/ui-ux-pro-max/data/stacks/react.csv
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,State,Use useState for local state,Simple component state should use useState hook,useState for form inputs toggles counters,Class components this.state,"const [count, setCount] = useState(0)",this.state = { count: 0 },Medium,https://react.dev/reference/react/useState
|
||||||
|
2,State,Lift state up when needed,Share state between siblings by lifting to parent,Lift shared state to common ancestor,Prop drilling through many levels,Parent holds state passes down,Deep prop chains,Medium,https://react.dev/learn/sharing-state-between-components
|
||||||
|
3,State,Use useReducer for complex state,Complex state logic benefits from reducer pattern,useReducer for state with multiple sub-values,Multiple useState for related values,useReducer with action types,5+ useState calls that update together,Medium,https://react.dev/reference/react/useReducer
|
||||||
|
4,State,Avoid unnecessary state,Derive values from existing state when possible,Compute derived values in render,Store derivable values in state,const total = items.reduce(...),"const [total, setTotal] = useState(0)",High,https://react.dev/learn/choosing-the-state-structure
|
||||||
|
5,State,Initialize state lazily,Use function form for expensive initial state,useState(() => computeExpensive()),useState(computeExpensive()),useState(() => JSON.parse(data)),useState(JSON.parse(data)),Medium,https://react.dev/reference/react/useState#avoiding-recreating-the-initial-state
|
||||||
|
6,Effects,Clean up effects,Return cleanup function for subscriptions timers,Return cleanup function in useEffect,No cleanup for subscriptions,useEffect(() => { sub(); return unsub; }),useEffect(() => { subscribe(); }),High,https://react.dev/reference/react/useEffect#connecting-to-an-external-system
|
||||||
|
7,Effects,Specify dependencies correctly,Include all values used inside effect in deps array,All referenced values in dependency array,Empty deps with external references,[value] when using value in effect,[] when using props/state in effect,High,https://react.dev/reference/react/useEffect#specifying-reactive-dependencies
|
||||||
|
8,Effects,Avoid unnecessary effects,Don't use effects for transforming data or events,Transform data during render handle events directly,useEffect for derived state or event handling,const filtered = items.filter(...),useEffect(() => setFiltered(items.filter(...))),High,https://react.dev/learn/you-might-not-need-an-effect
|
||||||
|
9,Effects,Use refs for non-reactive values,Store values that don't trigger re-renders in refs,useRef for interval IDs DOM elements,useState for values that don't need render,const intervalRef = useRef(null),"const [intervalId, setIntervalId] = useState()",Medium,https://react.dev/reference/react/useRef
|
||||||
|
10,Rendering,Use keys properly,Stable unique keys for list items,Use stable IDs as keys,Array index as key for dynamic lists,key={item.id},key={index},High,https://react.dev/learn/rendering-lists#keeping-list-items-in-order-with-key
|
||||||
|
11,Rendering,Memoize expensive calculations,Use useMemo for costly computations,useMemo for expensive filtering/sorting,Recalculate every render,"useMemo(() => expensive(), [deps])",const result = expensiveCalc(),Medium,https://react.dev/reference/react/useMemo
|
||||||
|
12,Rendering,Memoize callbacks passed to children,Use useCallback for functions passed as props,useCallback for handlers passed to memoized children,New function reference every render,"useCallback(() => {}, [deps])",const handler = () => {},Medium,https://react.dev/reference/react/useCallback
|
||||||
|
13,Rendering,Use React.memo wisely,Wrap components that render often with same props,memo for pure components with stable props,memo everything or nothing,memo(ExpensiveList),memo(SimpleButton),Low,https://react.dev/reference/react/memo
|
||||||
|
14,Rendering,Avoid inline object/array creation in JSX,Create objects outside render or memoize,Define style objects outside component,Inline objects in props,<div style={styles.container}>,<div style={{ margin: 10 }}>,Medium,
|
||||||
|
15,Components,Keep components small and focused,Single responsibility for each component,One concern per component,Large multi-purpose components,<UserAvatar /><UserName />,<UserCard /> with 500 lines,Medium,
|
||||||
|
16,Components,Use composition over inheritance,Compose components using children and props,Use children prop for flexibility,Inheritance hierarchies,<Card>{content}</Card>,class SpecialCard extends Card,Medium,https://react.dev/learn/thinking-in-react
|
||||||
|
17,Components,Colocate related code,Keep related components and hooks together,Related files in same directory,Flat structure with many files,components/User/UserCard.tsx,components/UserCard.tsx + hooks/useUser.ts,Low,
|
||||||
|
18,Components,Use fragments to avoid extra DOM,Fragment or <> for multiple elements without wrapper,<> for grouping without DOM node,Extra div wrappers,<>{items.map(...)}</>,<div>{items.map(...)}</div>,Low,https://react.dev/reference/react/Fragment
|
||||||
|
19,Props,Destructure props,Destructure props for cleaner component code,Destructure in function signature,props.name props.value throughout,"function User({ name, age })",function User(props),Low,
|
||||||
|
20,Props,Provide default props values,Use default parameters or defaultProps,Default values in destructuring,Undefined checks throughout,function Button({ size = 'md' }),if (size === undefined) size = 'md',Low,
|
||||||
|
21,Props,Avoid prop drilling,Use context or composition for deeply nested data,Context for global data composition for UI,Passing props through 5+ levels,<UserContext.Provider>,<A user={u}><B user={u}><C user={u}>,Medium,https://react.dev/learn/passing-data-deeply-with-context
|
||||||
|
22,Props,Validate props with TypeScript,Use TypeScript interfaces for prop types,interface Props { name: string },PropTypes or no validation,interface ButtonProps { onClick: () => void },Button.propTypes = {},Medium,
|
||||||
|
23,Events,Use synthetic events correctly,React normalizes events across browsers,e.preventDefault() e.stopPropagation(),Access native event unnecessarily,onClick={(e) => e.preventDefault()},onClick={(e) => e.nativeEvent.preventDefault()},Low,https://react.dev/reference/react-dom/components/common#react-event-object
|
||||||
|
24,Events,Avoid binding in render,Use arrow functions in class or hooks,Arrow functions in functional components,bind in render or constructor,const handleClick = () => {},this.handleClick.bind(this),Medium,
|
||||||
|
25,Events,Pass event handlers not call results,Pass function reference not invocation,onClick={handleClick},onClick={handleClick()} causing immediate call,onClick={handleClick},onClick={handleClick()},High,
|
||||||
|
26,Forms,Controlled components for forms,Use state to control form inputs,value + onChange for inputs,Uncontrolled inputs with refs,<input value={val} onChange={setVal}>,<input ref={inputRef}>,Medium,https://react.dev/reference/react-dom/components/input#controlling-an-input-with-a-state-variable
|
||||||
|
27,Forms,Handle form submission properly,Prevent default and handle in submit handler,onSubmit with preventDefault,onClick on submit button only,<form onSubmit={handleSubmit}>,<button onClick={handleSubmit}>,Medium,
|
||||||
|
28,Forms,Debounce rapid input changes,Debounce search/filter inputs,useDeferredValue or debounce for search,Filter on every keystroke,useDeferredValue(searchTerm),useEffect filtering on every change,Medium,https://react.dev/reference/react/useDeferredValue
|
||||||
|
29,Hooks,Follow rules of hooks,Only call hooks at top level and in React functions,Hooks at component top level,Hooks in conditions loops or callbacks,"const [x, setX] = useState()","if (cond) { const [x, setX] = useState() }",High,https://react.dev/reference/rules/rules-of-hooks
|
||||||
|
30,Hooks,Custom hooks for reusable logic,Extract shared stateful logic to custom hooks,useCustomHook for reusable patterns,Duplicate hook logic across components,const { data } = useFetch(url),Duplicate useEffect/useState in components,Medium,https://react.dev/learn/reusing-logic-with-custom-hooks
|
||||||
|
31,Hooks,Name custom hooks with use prefix,Custom hooks must start with use,useFetch useForm useAuth,fetchData or getData for hook,function useFetch(url),function fetchData(url),High,
|
||||||
|
32,Context,Use context for global data,Context for theme auth locale,Context for app-wide state,Context for frequently changing data,<ThemeContext.Provider>,Context for form field values,Medium,https://react.dev/learn/passing-data-deeply-with-context
|
||||||
|
33,Context,Split contexts by concern,Separate contexts for different domains,ThemeContext + AuthContext,One giant AppContext,<ThemeProvider><AuthProvider>,<AppProvider value={{theme user...}}>,Medium,
|
||||||
|
34,Context,Memoize context values,Prevent unnecessary re-renders with useMemo,useMemo for context value object,New object reference every render,"value={useMemo(() => ({...}), [])}","value={{ user, theme }}",High,
|
||||||
|
35,Performance,Use React DevTools Profiler,Profile to identify performance bottlenecks,Profile before optimizing,Optimize without measuring,React DevTools Profiler,Guessing at bottlenecks,Medium,https://react.dev/learn/react-developer-tools
|
||||||
|
36,Performance,Lazy load components,Use React.lazy for code splitting,lazy() for routes and heavy components,Import everything upfront,const Page = lazy(() => import('./Page')),import Page from './Page',Medium,https://react.dev/reference/react/lazy
|
||||||
|
37,Performance,Virtualize long lists,Use windowing for lists over 100 items,react-window or react-virtual,Render thousands of DOM nodes,<VirtualizedList items={items}/>,{items.map(i => <Item />)},High,
|
||||||
|
38,Performance,Batch state updates,React 18 auto-batches but be aware,Let React batch related updates,Manual batching with flushSync,setA(1); setB(2); // batched,flushSync(() => setA(1)),Low,https://react.dev/learn/queueing-a-series-of-state-updates
|
||||||
|
39,ErrorHandling,Use error boundaries,Catch JavaScript errors in component tree,ErrorBoundary wrapping sections,Let errors crash entire app,<ErrorBoundary><App/></ErrorBoundary>,No error handling,High,https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary
|
||||||
|
40,ErrorHandling,Handle async errors,Catch errors in async operations,try/catch in async handlers,Unhandled promise rejections,try { await fetch() } catch(e) {},await fetch() // no catch,High,
|
||||||
|
41,Testing,Test behavior not implementation,Test what user sees and does,Test renders and interactions,Test internal state or methods,expect(screen.getByText('Hello')),expect(component.state.name),Medium,https://testing-library.com/docs/react-testing-library/intro/
|
||||||
|
42,Testing,Use testing-library queries,Use accessible queries,getByRole getByLabelText,getByTestId for everything,getByRole('button'),getByTestId('submit-btn'),Medium,https://testing-library.com/docs/queries/about#priority
|
||||||
|
43,Accessibility,Use semantic HTML,Proper HTML elements for their purpose,button for clicks nav for navigation,div with onClick for buttons,<button onClick={...}>,<div onClick={...}>,High,https://react.dev/reference/react-dom/components#all-html-components
|
||||||
|
44,Accessibility,Manage focus properly,Handle focus for modals dialogs,Focus trap in modals return focus on close,No focus management,useEffect to focus input,Modal without focus trap,High,
|
||||||
|
45,Accessibility,Announce dynamic content,Use ARIA live regions for updates,aria-live for dynamic updates,Silent updates to screen readers,"<div aria-live=""polite"">{msg}</div>",<div>{msg}</div>,Medium,
|
||||||
|
46,Accessibility,Label form controls,Associate labels with inputs,htmlFor matching input id,Placeholder as only label,"<label htmlFor=""email"">Email</label>","<input placeholder=""Email""/>",High,
|
||||||
|
47,TypeScript,Type component props,Define interfaces for all props,interface Props with all prop types,any or missing types,interface Props { name: string },function Component(props: any),High,
|
||||||
|
48,TypeScript,Type state properly,Provide types for useState,useState<Type>() for complex state,Inferred any types,useState<User | null>(null),useState(null),Medium,
|
||||||
|
49,TypeScript,Type event handlers,Use React event types,React.ChangeEvent<HTMLInputElement>,Generic Event type,onChange: React.ChangeEvent<HTMLInputElement>,onChange: Event,Medium,
|
||||||
|
50,TypeScript,Use generics for reusable components,Generic components for flexible typing,Generic props for list components,Union types for flexibility,<List<T> items={T[]}>,<List items={any[]}>,Medium,
|
||||||
|
51,Patterns,Container/Presentational split,Separate data logic from UI,Container fetches presentational renders,Mixed data and UI in one,<UserContainer><UserView/></UserContainer>,<User /> with fetch and render,Low,
|
||||||
|
52,Patterns,Render props for flexibility,Share code via render prop pattern,Render prop for customizable rendering,Duplicate logic across components,<DataFetcher render={data => ...}/>,Copy paste fetch logic,Low,https://react.dev/reference/react/cloneElement#passing-data-with-a-render-prop
|
||||||
|
53,Patterns,Compound components,Related components sharing state,Tab + TabPanel sharing context,Prop drilling between related,<Tabs><Tab/><TabPanel/></Tabs>,<Tabs tabs={[]} panels={[...]}/>,Low,
|
||||||
|
54
.claude/skills/ui-ux-pro-max/data/stacks/svelte.csv
Normal file
54
.claude/skills/ui-ux-pro-max/data/stacks/svelte.csv
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Reactivity,Use $: for reactive statements,Automatic dependency tracking,$: for derived values,Manual recalculation,$: doubled = count * 2,let doubled; count && (doubled = count * 2),Medium,https://svelte.dev/docs/svelte-components#script-3-$-marks-a-statement-as-reactive
|
||||||
|
2,Reactivity,Trigger reactivity with assignment,Svelte tracks assignments not mutations,Reassign arrays/objects to trigger update,Mutate without reassignment,"items = [...items, newItem]",items.push(newItem),High,https://svelte.dev/docs/svelte-components#script-2-assignments-are-reactive
|
||||||
|
3,Reactivity,Use $state in Svelte 5,Runes for explicit reactivity,let count = $state(0),Implicit reactivity in Svelte 5,let count = $state(0),let count = 0 (Svelte 5),Medium,https://svelte.dev/blog/runes
|
||||||
|
4,Reactivity,Use $derived for computed values,$derived replaces $: in Svelte 5,let doubled = $derived(count * 2),$: in Svelte 5,let doubled = $derived(count * 2),$: doubled = count * 2 (Svelte 5),Medium,
|
||||||
|
5,Reactivity,Use $effect for side effects,$effect replaces $: side effects,Use $effect for subscriptions,$: for side effects in Svelte 5,$effect(() => console.log(count)),$: console.log(count) (Svelte 5),Medium,
|
||||||
|
6,Props,Export let for props,Declare props with export let,export let propName,Props without export,export let count = 0,let count = 0,High,https://svelte.dev/docs/svelte-components#script-1-export-creates-a-component-prop
|
||||||
|
7,Props,Use $props in Svelte 5,$props rune for prop access,let { name } = $props(),export let in Svelte 5,"let { name, age = 0 } = $props()",export let name; export let age = 0,Medium,
|
||||||
|
8,Props,Provide default values,Default props with assignment,export let count = 0,Required props without defaults,export let count = 0,export let count,Low,
|
||||||
|
9,Props,Use spread props,Pass through unknown props,{...$$restProps} on elements,Manual prop forwarding,<button {...$$restProps}>,<button class={$$props.class}>,Low,https://svelte.dev/docs/basic-markup#attributes-and-props
|
||||||
|
10,Bindings,Use bind: for two-way binding,Simplified input handling,bind:value for inputs,on:input with manual update,<input bind:value={name}>,<input value={name} on:input={e => name = e.target.value}>,Low,https://svelte.dev/docs/element-directives#bind-property
|
||||||
|
11,Bindings,Bind to DOM elements,Reference DOM nodes,bind:this for element reference,querySelector in onMount,<div bind:this={el}>,onMount(() => el = document.querySelector()),Medium,
|
||||||
|
12,Bindings,Use bind:group for radios/checkboxes,Simplified group handling,bind:group for radio/checkbox groups,Manual checked handling,"<input type=""radio"" bind:group={selected}>","<input type=""radio"" checked={selected === value}>",Low,
|
||||||
|
13,Events,Use on: for event handlers,Event directive syntax,on:click={handler},addEventListener in onMount,<button on:click={handleClick}>,onMount(() => btn.addEventListener()),Medium,https://svelte.dev/docs/element-directives#on-eventname
|
||||||
|
14,Events,Forward events with on:event,Pass events to parent,on:click without handler,createEventDispatcher for DOM events,<button on:click>,"dispatch('click', event)",Low,
|
||||||
|
15,Events,Use createEventDispatcher,Custom component events,dispatch for custom events,on:event for custom events,"dispatch('save', { data })",on:save without dispatch,Medium,https://svelte.dev/docs/svelte#createeventdispatcher
|
||||||
|
16,Lifecycle,Use onMount for initialization,Run code after component mounts,onMount for setup and data fetching,Code in script body for side effects,onMount(() => fetchData()),fetchData() in script body,High,https://svelte.dev/docs/svelte#onmount
|
||||||
|
17,Lifecycle,Return cleanup from onMount,Automatic cleanup on destroy,Return function from onMount,Separate onDestroy for paired cleanup,onMount(() => { sub(); return unsub }),onMount(sub); onDestroy(unsub),Medium,
|
||||||
|
18,Lifecycle,Use onDestroy sparingly,Only when onMount cleanup not possible,onDestroy for non-mount cleanup,onDestroy for mount-related cleanup,onDestroy for store unsubscribe,onDestroy(() => clearInterval(id)),Low,
|
||||||
|
19,Lifecycle,Avoid beforeUpdate/afterUpdate,Usually not needed,Reactive statements instead,beforeUpdate for derived state,$: if (x) doSomething(),beforeUpdate(() => doSomething()),Low,
|
||||||
|
20,Stores,Use writable for mutable state,Basic reactive store,writable for shared mutable state,Local variables for shared state,const count = writable(0),let count = 0 in module,Medium,https://svelte.dev/docs/svelte-store#writable
|
||||||
|
21,Stores,Use readable for read-only state,External data sources,readable for derived/external data,writable for read-only data,"readable(0, set => interval(set))",writable(0) for timer,Low,https://svelte.dev/docs/svelte-store#readable
|
||||||
|
22,Stores,Use derived for computed stores,Combine or transform stores,derived for computed values,Manual subscription for derived,"derived(count, $c => $c * 2)",count.subscribe(c => doubled = c * 2),Medium,https://svelte.dev/docs/svelte-store#derived
|
||||||
|
23,Stores,Use $ prefix for auto-subscription,Automatic subscribe/unsubscribe,$storeName in components,Manual subscription,{$count},count.subscribe(c => value = c),High,
|
||||||
|
24,Stores,Clean up custom subscriptions,Unsubscribe when component destroys,Return unsubscribe from onMount,Leave subscriptions open,onMount(() => store.subscribe(fn)),store.subscribe(fn) in script,High,
|
||||||
|
25,Slots,Use slots for composition,Content projection,<slot> for flexible content,Props for all content,<slot>Default</slot>,"<Component content=""text""/>",Medium,https://svelte.dev/docs/special-elements#slot
|
||||||
|
26,Slots,Name slots for multiple areas,Multiple content areas,"<slot name=""header"">",Single slot for complex layouts,"<slot name=""header""><slot name=""footer"">",<slot> with complex conditionals,Low,
|
||||||
|
27,Slots,Check slot content with $$slots,Conditional slot rendering,$$slots.name for conditional rendering,Always render slot wrapper,"{#if $$slots.footer}<slot name=""footer""/>{/if}","<div><slot name=""footer""/></div>",Low,
|
||||||
|
28,Styling,Use scoped styles by default,Styles scoped to component,<style> for component styles,Global styles for component,:global() only when needed,<style> all global,Medium,https://svelte.dev/docs/svelte-components#style
|
||||||
|
29,Styling,Use :global() sparingly,Escape scoping when needed,:global for third-party styling,Global for all styles,:global(.external-lib),<style> without scoping,Medium,
|
||||||
|
30,Styling,Use CSS variables for theming,Dynamic styling,CSS custom properties,Inline styles for themes,"style=""--color: {color}""","style=""color: {color}""",Low,
|
||||||
|
31,Transitions,Use built-in transitions,Svelte transition directives,transition:fade for simple effects,Manual CSS transitions,<div transition:fade>,<div class:fade={visible}>,Low,https://svelte.dev/docs/element-directives#transition-fn
|
||||||
|
32,Transitions,Use in: and out: separately,Different enter/exit animations,in:fly out:fade for asymmetric,Same transition for both,<div in:fly out:fade>,<div transition:fly>,Low,
|
||||||
|
33,Transitions,Add local modifier,Prevent ancestor trigger,transition:fade|local,Global transitions for lists,<div transition:slide|local>,<div transition:slide>,Medium,
|
||||||
|
34,Actions,Use actions for DOM behavior,Reusable DOM logic,use:action for DOM enhancements,onMount for each usage,<div use:clickOutside>,onMount(() => setupClickOutside(el)),Medium,https://svelte.dev/docs/element-directives#use-action
|
||||||
|
35,Actions,Return update and destroy,Lifecycle methods for actions,"Return { update, destroy }",Only initial setup,"return { update(params) {}, destroy() {} }",return destroy only,Medium,
|
||||||
|
36,Actions,Pass parameters to actions,Configure action behavior,use:action={params},Hardcoded action behavior,<div use:tooltip={options}>,<div use:tooltip>,Low,
|
||||||
|
37,Logic,Use {#if} for conditionals,Template conditionals,{#if} {:else if} {:else},Ternary in expressions,{#if cond}...{:else}...{/if},{cond ? a : b} for complex,Low,https://svelte.dev/docs/logic-blocks#if
|
||||||
|
38,Logic,Use {#each} for lists,List rendering,{#each} with key,Map in expression,{#each items as item (item.id)},{items.map(i => `<div>${i}</div>`)},Medium,
|
||||||
|
39,Logic,Always use keys in {#each},Proper list reconciliation,(item.id) for unique key,Index as key or no key,{#each items as item (item.id)},"{#each items as item, i (i)}",High,
|
||||||
|
40,Logic,Use {#await} for promises,Handle async states,{#await} for loading/error states,Manual promise handling,{#await promise}...{:then}...{:catch},{#if loading}...{#if error},Medium,https://svelte.dev/docs/logic-blocks#await
|
||||||
|
41,SvelteKit,Use +page.svelte for routes,File-based routing,+page.svelte for route components,Custom routing setup,routes/about/+page.svelte,routes/About.svelte,Medium,https://kit.svelte.dev/docs/routing
|
||||||
|
42,SvelteKit,Use +page.js for data loading,Load data before render,load function in +page.js,onMount for data fetching,export function load() {},onMount(() => fetchData()),High,https://kit.svelte.dev/docs/load
|
||||||
|
43,SvelteKit,Use +page.server.js for server-only,Server-side data loading,+page.server.js for sensitive data,+page.js for API keys,+page.server.js with DB access,+page.js with DB access,High,
|
||||||
|
44,SvelteKit,Use form actions,Server-side form handling,+page.server.js actions,API routes for forms,export const actions = { default },fetch('/api/submit'),Medium,https://kit.svelte.dev/docs/form-actions
|
||||||
|
45,SvelteKit,Use $app/stores for app state,$page $navigating $updated,$page for current page data,Manual URL parsing,import { page } from '$app/stores',window.location.pathname,Medium,https://kit.svelte.dev/docs/modules#$app-stores
|
||||||
|
46,Performance,Use {#key} for forced re-render,Reset component state,{#key id} for fresh instance,Manual destroy/create,{#key item.id}<Component/>{/key},on:change={() => component = null},Low,https://svelte.dev/docs/logic-blocks#key
|
||||||
|
47,Performance,Avoid unnecessary reactivity,Not everything needs $:,$: only for side effects,$: for simple assignments,$: if (x) console.log(x),$: y = x (when y = x works),Low,
|
||||||
|
48,Performance,Use immutable compiler option,Skip equality checks,immutable: true for large lists,Default for all components,<svelte:options immutable/>,Default without immutable,Low,
|
||||||
|
49,TypeScript,"Use lang=""ts"" in script",TypeScript support,"<script lang=""ts"">",JavaScript for typed projects,"<script lang=""ts"">",<script> with JSDoc,Medium,https://svelte.dev/docs/typescript
|
||||||
|
50,TypeScript,Type props with interface,Explicit prop types,interface $$Props for types,Untyped props,interface $$Props { name: string },export let name,Medium,
|
||||||
|
51,TypeScript,Type events with createEventDispatcher,Type-safe events,createEventDispatcher<Events>(),Untyped dispatch,createEventDispatcher<{ save: Data }>(),createEventDispatcher(),Medium,
|
||||||
|
52,Accessibility,Use semantic elements,Proper HTML in templates,button nav main appropriately,div for everything,<button on:click>,<div on:click>,High,
|
||||||
|
53,Accessibility,Add aria to dynamic content,Accessible state changes,aria-live for updates,Silent dynamic updates,"<div aria-live=""polite"">{message}</div>",<div>{message}</div>,Medium,
|
||||||
|
51
.claude/skills/ui-ux-pro-max/data/stacks/swiftui.csv
Normal file
51
.claude/skills/ui-ux-pro-max/data/stacks/swiftui.csv
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Views,Use struct for views,SwiftUI views are value types,struct MyView: View,class MyView: View,struct ContentView: View { var body: some View },class ContentView: View,High,https://developer.apple.com/documentation/swiftui/view
|
||||||
|
2,Views,Keep views small and focused,Single responsibility for each view,Extract subviews for complex layouts,Large monolithic views,Extract HeaderView FooterView,500+ line View struct,Medium,
|
||||||
|
3,Views,Use body computed property,body returns the view hierarchy,var body: some View { },func body() -> some View,"var body: some View { Text(""Hello"") }",func body() -> Text,High,
|
||||||
|
4,Views,Prefer composition over inheritance,Compose views using ViewBuilder,Combine smaller views,Inheritance hierarchies,VStack { Header() Content() },class SpecialView extends BaseView,Medium,
|
||||||
|
5,State,Use @State for local state,Simple value types owned by view,@State for view-local primitives,@State for shared data,@State private var count = 0,@State var sharedData: Model,High,https://developer.apple.com/documentation/swiftui/state
|
||||||
|
6,State,Use @Binding for two-way data,Pass mutable state to child views,@Binding for child input,@State in child for parent data,@Binding var isOn: Bool,$isOn to pass binding,Medium,https://developer.apple.com/documentation/swiftui/binding
|
||||||
|
7,State,Use @StateObject for reference types,ObservableObject owned by view,@StateObject for view-created objects,@ObservedObject for owned objects,@StateObject private var vm = ViewModel(),@ObservedObject var vm = ViewModel(),High,https://developer.apple.com/documentation/swiftui/stateobject
|
||||||
|
8,State,Use @ObservedObject for injected objects,Reference types passed from parent,@ObservedObject for injected dependencies,@StateObject for injected objects,@ObservedObject var vm: ViewModel,@StateObject var vm: ViewModel (injected),High,https://developer.apple.com/documentation/swiftui/observedobject
|
||||||
|
9,State,Use @EnvironmentObject for shared state,App-wide state injection,@EnvironmentObject for global state,Prop drilling through views,@EnvironmentObject var settings: Settings,Pass settings through 5 views,Medium,https://developer.apple.com/documentation/swiftui/environmentobject
|
||||||
|
10,State,Use @Published in ObservableObject,Automatically publish property changes,@Published for observed properties,Manual objectWillChange calls,@Published var items: [Item] = [],var items: [Item] { didSet { objectWillChange.send() } },Medium,
|
||||||
|
11,Observable,Use @Observable macro (iOS 17+),Modern observation without Combine,@Observable class for view models,ObservableObject for new projects,@Observable class ViewModel { },class ViewModel: ObservableObject,Medium,https://developer.apple.com/documentation/observation
|
||||||
|
12,Observable,Use @Bindable for @Observable,Create bindings from @Observable,@Bindable var vm for bindings,@Binding with @Observable,@Bindable var viewModel,$viewModel.name with @Observable,Medium,
|
||||||
|
13,Layout,Use VStack HStack ZStack,Standard stack-based layouts,Stacks for linear arrangements,GeometryReader for simple layouts,VStack { Text() Image() },GeometryReader for vertical list,Medium,https://developer.apple.com/documentation/swiftui/vstack
|
||||||
|
14,Layout,Use LazyVStack LazyHStack for lists,Lazy loading for performance,Lazy stacks for long lists,Regular stacks for 100+ items,LazyVStack { ForEach(items) },VStack { ForEach(largeArray) },High,https://developer.apple.com/documentation/swiftui/lazyvstack
|
||||||
|
15,Layout,Use GeometryReader sparingly,Only when needed for sizing,GeometryReader for responsive layouts,GeometryReader everywhere,GeometryReader for aspect ratio,GeometryReader wrapping everything,Medium,
|
||||||
|
16,Layout,Use spacing and padding consistently,Consistent spacing throughout app,Design system spacing values,Magic numbers for spacing,.padding(16) or .padding(),".padding(13), .padding(17)",Low,
|
||||||
|
17,Layout,Use frame modifiers correctly,Set explicit sizes when needed,.frame(maxWidth: .infinity),Fixed sizes for responsive content,.frame(maxWidth: .infinity),.frame(width: 375),Medium,
|
||||||
|
18,Modifiers,Order modifiers correctly,Modifier order affects rendering,Background before padding for full coverage,Wrong modifier order,.padding().background(Color.red),.background(Color.red).padding(),High,
|
||||||
|
19,Modifiers,Create custom ViewModifiers,Reusable modifier combinations,ViewModifier for repeated styling,Duplicate modifier chains,struct CardStyle: ViewModifier,.shadow().cornerRadius() everywhere,Medium,https://developer.apple.com/documentation/swiftui/viewmodifier
|
||||||
|
20,Modifiers,Use conditional modifiers carefully,Avoid changing view identity,if-else with same view type,Conditional that changes view identity,Text(title).foregroundColor(isActive ? .blue : .gray),if isActive { Text().bold() } else { Text() },Medium,
|
||||||
|
21,Navigation,Use NavigationStack (iOS 16+),Modern navigation with type-safe paths,NavigationStack with navigationDestination,NavigationView for new projects,NavigationStack { },NavigationView { } (deprecated),Medium,https://developer.apple.com/documentation/swiftui/navigationstack
|
||||||
|
22,Navigation,Use navigationDestination,Type-safe navigation destinations,.navigationDestination(for:),NavigationLink(destination:),.navigationDestination(for: Item.self),NavigationLink(destination: DetailView()),Medium,
|
||||||
|
23,Navigation,Use @Environment for dismiss,Programmatic navigation dismissal,@Environment(\.dismiss) var dismiss,presentationMode (deprecated),@Environment(\.dismiss) var dismiss,@Environment(\.presentationMode),Low,
|
||||||
|
24,Lists,Use List for scrollable content,Built-in scrolling and styling,List for standard scrollable content,ScrollView + VStack for simple lists,List { ForEach(items) { } },ScrollView { VStack { ForEach } },Low,https://developer.apple.com/documentation/swiftui/list
|
||||||
|
25,Lists,Provide stable identifiers,Use Identifiable or explicit id,Identifiable protocol or id parameter,Index as identifier,ForEach(items) where Item: Identifiable,"ForEach(items.indices, id: \.self)",High,
|
||||||
|
26,Lists,Use onDelete and onMove,Standard list editing,onDelete for swipe to delete,Custom delete implementation,.onDelete(perform: delete),.onTapGesture for delete,Low,
|
||||||
|
27,Forms,Use Form for settings,Grouped input controls,Form for settings screens,Manual grouping for forms,Form { Section { Toggle() } },VStack { Toggle() },Low,https://developer.apple.com/documentation/swiftui/form
|
||||||
|
28,Forms,Use @FocusState for keyboard,Manage keyboard focus,@FocusState for text field focus,Manual first responder handling,@FocusState private var isFocused: Bool,UIKit first responder,Medium,https://developer.apple.com/documentation/swiftui/focusstate
|
||||||
|
29,Forms,Validate input properly,Show validation feedback,Real-time validation feedback,Submit without validation,TextField with validation state,TextField without error handling,Medium,
|
||||||
|
30,Async,Use .task for async work,Automatic cancellation on view disappear,.task for view lifecycle async,onAppear with Task,.task { await loadData() },onAppear { Task { await loadData() } },Medium,https://developer.apple.com/documentation/swiftui/view/task(priority:_:)
|
||||||
|
31,Async,Handle loading states,Show progress during async operations,ProgressView during loading,Empty view during load,if isLoading { ProgressView() },No loading indicator,Medium,
|
||||||
|
32,Async,Use @MainActor for UI updates,Ensure UI updates on main thread,@MainActor on view models,Manual DispatchQueue.main,@MainActor class ViewModel,DispatchQueue.main.async,Medium,
|
||||||
|
33,Animation,Use withAnimation,Animate state changes,withAnimation for state transitions,No animation for state changes,withAnimation { isExpanded.toggle() },isExpanded.toggle(),Low,https://developer.apple.com/documentation/swiftui/withanimation(_:_:)
|
||||||
|
34,Animation,Use .animation modifier,Apply animations to views,.animation(.spring()) on view,Manual animation timing,.animation(.easeInOut),CABasicAnimation equivalent,Low,
|
||||||
|
35,Animation,Respect reduced motion,Check accessibility settings,Check accessibilityReduceMotion,Ignore motion preferences,@Environment(\.accessibilityReduceMotion),Always animate regardless,High,
|
||||||
|
36,Preview,Use #Preview macro (Xcode 15+),Modern preview syntax,#Preview for view previews,PreviewProvider protocol,#Preview { ContentView() },struct ContentView_Previews: PreviewProvider,Low,
|
||||||
|
37,Preview,Create multiple previews,Test different states and devices,Multiple previews for states,Single preview only,"#Preview(""Light"") { } #Preview(""Dark"") { }",Single preview configuration,Low,
|
||||||
|
38,Preview,Use preview data,Dedicated preview mock data,Static preview data,Production data in previews,Item.preview for preview,Fetch real data in preview,Low,
|
||||||
|
39,Performance,Avoid expensive body computations,Body should be fast to compute,Precompute in view model,Heavy computation in body,vm.computedValue in body,Complex calculation in body,High,
|
||||||
|
40,Performance,Use Equatable views,Skip unnecessary view updates,Equatable for complex views,Default equality for all views,struct MyView: View Equatable,No Equatable conformance,Medium,
|
||||||
|
41,Performance,Profile with Instruments,Measure before optimizing,Use SwiftUI Instruments,Guess at performance issues,Profile with Instruments,Optimize without measuring,Medium,
|
||||||
|
42,Accessibility,Add accessibility labels,Describe UI elements,.accessibilityLabel for context,Missing labels,".accessibilityLabel(""Close button"")",Button without label,High,https://developer.apple.com/documentation/swiftui/view/accessibilitylabel(_:)-1d7jv
|
||||||
|
43,Accessibility,Support Dynamic Type,Respect text size preferences,Scalable fonts and layouts,Fixed font sizes,.font(.body) with Dynamic Type,.font(.system(size: 16)),High,
|
||||||
|
44,Accessibility,Use semantic views,Proper accessibility traits,Correct accessibilityTraits,Wrong semantic meaning,Button for actions Image for display,Image that acts like button,Medium,
|
||||||
|
45,Testing,Use ViewInspector for testing,Third-party view testing,ViewInspector for unit tests,UI tests only,ViewInspector assertions,Only XCUITest,Medium,
|
||||||
|
46,Testing,Test view models,Unit test business logic,XCTest for view model,Skip view model testing,Test ViewModel methods,No unit tests,Medium,
|
||||||
|
47,Testing,Use preview as visual test,Previews catch visual regressions,Multiple preview configurations,No visual verification,Preview different states,Single preview only,Low,
|
||||||
|
48,Architecture,Use MVVM pattern,Separate view and logic,ViewModel for business logic,Logic in View,ObservableObject ViewModel,@State for complex logic,Medium,
|
||||||
|
49,Architecture,Keep views dumb,Views display view model state,View reads from ViewModel,Business logic in View,view.items from vm.items,Complex filtering in View,Medium,
|
||||||
|
50,Architecture,Use dependency injection,Inject dependencies for testing,Initialize with dependencies,Hard-coded dependencies,init(service: ServiceProtocol),let service = RealService(),Medium,
|
||||||
|
50
.claude/skills/ui-ux-pro-max/data/stacks/vue.csv
Normal file
50
.claude/skills/ui-ux-pro-max/data/stacks/vue.csv
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Composition,Use Composition API for new projects,Composition API offers better TypeScript support and logic reuse,<script setup> for components,Options API for new projects,<script setup>,export default { data() },Medium,https://vuejs.org/guide/extras/composition-api-faq.html
|
||||||
|
2,Composition,Use script setup syntax,Cleaner syntax with automatic exports,<script setup> with defineProps,setup() function manually,<script setup>,<script> setup() { return {} },Low,https://vuejs.org/api/sfc-script-setup.html
|
||||||
|
3,Reactivity,Use ref for primitives,ref() for primitive values that need reactivity,ref() for strings numbers booleans,reactive() for primitives,const count = ref(0),const count = reactive(0),Medium,https://vuejs.org/guide/essentials/reactivity-fundamentals.html
|
||||||
|
4,Reactivity,Use reactive for objects,reactive() for complex objects and arrays,reactive() for objects with multiple properties,ref() for complex objects,const state = reactive({ user: null }),const state = ref({ user: null }),Medium,
|
||||||
|
5,Reactivity,Access ref values with .value,Remember .value in script unwrap in template,Use .value in script,Forget .value in script,count.value++,count++ (in script),High,
|
||||||
|
6,Reactivity,Use computed for derived state,Computed properties cache and update automatically,computed() for derived values,Methods for derived values,const doubled = computed(() => count.value * 2),const doubled = () => count.value * 2,Medium,https://vuejs.org/guide/essentials/computed.html
|
||||||
|
7,Reactivity,Use shallowRef for large objects,Avoid deep reactivity for performance,shallowRef for large data structures,ref for large nested objects,const bigData = shallowRef(largeObject),const bigData = ref(largeObject),Medium,https://vuejs.org/api/reactivity-advanced.html#shallowref
|
||||||
|
8,Watchers,Use watchEffect for simple cases,Auto-tracks dependencies,watchEffect for simple reactive effects,watch with explicit deps when not needed,watchEffect(() => console.log(count.value)),"watch(count, (val) => console.log(val))",Low,https://vuejs.org/guide/essentials/watchers.html
|
||||||
|
9,Watchers,Use watch for specific sources,Explicit control over what to watch,watch with specific refs,watchEffect for complex conditional logic,"watch(userId, fetchUser)",watchEffect with conditionals,Medium,
|
||||||
|
10,Watchers,Clean up side effects,Return cleanup function in watchers,Return cleanup in watchEffect,Leave subscriptions open,watchEffect((onCleanup) => { onCleanup(unsub) }),watchEffect without cleanup,High,
|
||||||
|
11,Props,Define props with defineProps,Type-safe prop definitions,defineProps with TypeScript,Props without types,defineProps<{ msg: string }>(),defineProps(['msg']),Medium,https://vuejs.org/guide/typescript/composition-api.html#typing-component-props
|
||||||
|
12,Props,Use withDefaults for default values,Provide defaults for optional props,withDefaults with defineProps,Defaults in destructuring,"withDefaults(defineProps<Props>(), { count: 0 })",const { count = 0 } = defineProps(),Medium,
|
||||||
|
13,Props,Avoid mutating props,Props should be read-only,Emit events to parent for changes,Direct prop mutation,"emit('update:modelValue', newVal)",props.modelValue = newVal,High,
|
||||||
|
14,Emits,Define emits with defineEmits,Type-safe event emissions,defineEmits with types,Emit without definition,defineEmits<{ change: [id: number] }>(),"emit('change', id) without define",Medium,https://vuejs.org/guide/typescript/composition-api.html#typing-component-emits
|
||||||
|
15,Emits,Use v-model for two-way binding,Simplified parent-child data flow,v-model with modelValue prop,:value + @input manually,"<Child v-model=""value""/>","<Child :value=""value"" @input=""value = $event""/>",Low,https://vuejs.org/guide/components/v-model.html
|
||||||
|
16,Lifecycle,Use onMounted for DOM access,DOM is ready in onMounted,onMounted for DOM operations,Access DOM in setup directly,onMounted(() => el.value.focus()),el.value.focus() in setup,High,https://vuejs.org/api/composition-api-lifecycle.html
|
||||||
|
17,Lifecycle,Clean up in onUnmounted,Remove listeners and subscriptions,onUnmounted for cleanup,Leave listeners attached,onUnmounted(() => window.removeEventListener()),No cleanup on unmount,High,
|
||||||
|
18,Lifecycle,Avoid onBeforeMount for data,Use onMounted or setup for data fetching,Fetch in onMounted or setup,Fetch in onBeforeMount,onMounted(async () => await fetchData()),onBeforeMount(async () => await fetchData()),Low,
|
||||||
|
19,Components,Use single-file components,Keep template script style together,.vue files for components,Separate template/script files,Component.vue with all parts,Component.js + Component.html,Low,
|
||||||
|
20,Components,Use PascalCase for components,Consistent component naming,PascalCase in imports and templates,kebab-case in script,<MyComponent/>,<my-component/>,Low,https://vuejs.org/style-guide/rules-strongly-recommended.html
|
||||||
|
21,Components,Prefer composition over mixins,Composables replace mixins,Composables for shared logic,Mixins for code reuse,const { data } = useApi(),mixins: [apiMixin],Medium,
|
||||||
|
22,Composables,Name composables with use prefix,Convention for composable functions,useFetch useAuth useForm,getData or fetchApi,export function useFetch(),export function fetchData(),Medium,https://vuejs.org/guide/reusability/composables.html
|
||||||
|
23,Composables,Return refs from composables,Maintain reactivity when destructuring,Return ref values,Return reactive objects that lose reactivity,return { data: ref(null) },return reactive({ data: null }),Medium,
|
||||||
|
24,Composables,Accept ref or value params,Use toValue for flexible inputs,toValue() or unref() for params,Only accept ref or only value,const val = toValue(maybeRef),const val = maybeRef.value,Low,https://vuejs.org/api/reactivity-utilities.html#tovalue
|
||||||
|
25,Templates,Use v-bind shorthand,Cleaner template syntax,:prop instead of v-bind:prop,Full v-bind syntax,"<div :class=""cls"">","<div v-bind:class=""cls"">",Low,
|
||||||
|
26,Templates,Use v-on shorthand,Cleaner event binding,@event instead of v-on:event,Full v-on syntax,"<button @click=""handler"">","<button v-on:click=""handler"">",Low,
|
||||||
|
27,Templates,Avoid v-if with v-for,v-if has higher priority causes issues,Wrap in template or computed filter,v-if on same element as v-for,<template v-for><div v-if>,<div v-for v-if>,High,https://vuejs.org/style-guide/rules-essential.html#avoid-v-if-with-v-for
|
||||||
|
28,Templates,Use key with v-for,Proper list rendering and updates,Unique key for each item,Index as key for dynamic lists,"v-for=""item in items"" :key=""item.id""","v-for=""(item, i) in items"" :key=""i""",High,
|
||||||
|
29,State,Use Pinia for global state,Official state management for Vue 3,Pinia stores for shared state,Vuex for new projects,const store = useCounterStore(),Vuex with mutations,Medium,https://pinia.vuejs.org/
|
||||||
|
30,State,Define stores with defineStore,Composition API style stores,Setup stores with defineStore,Options stores for complex state,"defineStore('counter', () => {})","defineStore('counter', { state })",Low,
|
||||||
|
31,State,Use storeToRefs for destructuring,Maintain reactivity when destructuring,storeToRefs(store),Direct destructuring,const { count } = storeToRefs(store),const { count } = store,High,https://pinia.vuejs.org/core-concepts/#destructuring-from-a-store
|
||||||
|
32,Routing,Use useRouter and useRoute,Composition API router access,useRouter() useRoute() in setup,this.$router this.$route,const router = useRouter(),this.$router.push(),Medium,https://router.vuejs.org/guide/advanced/composition-api.html
|
||||||
|
33,Routing,Lazy load route components,Code splitting for routes,() => import() for components,Static imports for all routes,component: () => import('./Page.vue'),component: Page,Medium,https://router.vuejs.org/guide/advanced/lazy-loading.html
|
||||||
|
34,Routing,Use navigation guards,Protect routes and handle redirects,beforeEach for auth checks,Check auth in each component,router.beforeEach((to) => {}),Check auth in onMounted,Medium,
|
||||||
|
35,Performance,Use v-once for static content,Skip re-renders for static elements,v-once on never-changing content,v-once on dynamic content,<div v-once>{{ staticText }}</div>,<div v-once>{{ dynamicText }}</div>,Low,https://vuejs.org/api/built-in-directives.html#v-once
|
||||||
|
36,Performance,Use v-memo for expensive lists,Memoize list items,v-memo with dependency array,Re-render entire list always,"<div v-for v-memo=""[item.id]"">",<div v-for> without memo,Medium,https://vuejs.org/api/built-in-directives.html#v-memo
|
||||||
|
37,Performance,Use shallowReactive for flat objects,Avoid deep reactivity overhead,shallowReactive for flat state,reactive for simple objects,shallowReactive({ count: 0 }),reactive({ count: 0 }),Low,
|
||||||
|
38,Performance,Use defineAsyncComponent,Lazy load heavy components,defineAsyncComponent for modals dialogs,Import all components eagerly,defineAsyncComponent(() => import()),import HeavyComponent from,Medium,https://vuejs.org/guide/components/async.html
|
||||||
|
39,TypeScript,Use generic components,Type-safe reusable components,Generic with defineComponent,Any types in components,"<script setup lang=""ts"" generic=""T"">",<script setup> without types,Medium,https://vuejs.org/guide/typescript/composition-api.html
|
||||||
|
40,TypeScript,Type template refs,Proper typing for DOM refs,ref<HTMLInputElement>(null),ref(null) without type,const input = ref<HTMLInputElement>(null),const input = ref(null),Medium,
|
||||||
|
41,TypeScript,Use PropType for complex props,Type complex prop types,PropType<User> for object props,Object without type,type: Object as PropType<User>,type: Object,Medium,
|
||||||
|
42,Testing,Use Vue Test Utils,Official testing library,mount shallowMount for components,Manual DOM testing,import { mount } from '@vue/test-utils',document.createElement,Medium,https://test-utils.vuejs.org/
|
||||||
|
43,Testing,Test component behavior,Focus on inputs and outputs,Test props emit and rendered output,Test internal implementation,expect(wrapper.text()).toContain(),expect(wrapper.vm.internalState),Medium,
|
||||||
|
44,Forms,Use v-model modifiers,Built-in input handling,.lazy .number .trim modifiers,Manual input parsing,"<input v-model.number=""age"">","<input v-model=""age""> then parse",Low,https://vuejs.org/guide/essentials/forms.html#modifiers
|
||||||
|
45,Forms,Use VeeValidate or FormKit,Form validation libraries,VeeValidate for complex forms,Manual validation logic,useField useForm from vee-validate,Custom validation in each input,Medium,
|
||||||
|
46,Accessibility,Use semantic elements,Proper HTML elements in templates,button nav main for purpose,div for everything,<button @click>,<div @click>,High,
|
||||||
|
47,Accessibility,Bind aria attributes dynamically,Keep ARIA in sync with state,":aria-expanded=""isOpen""",Static ARIA values,":aria-expanded=""menuOpen""","aria-expanded=""true""",Medium,
|
||||||
|
48,SSR,Use Nuxt for SSR,Full-featured SSR framework,Nuxt 3 for SSR apps,Manual SSR setup,npx nuxi init my-app,Custom SSR configuration,Medium,https://nuxt.com/
|
||||||
|
49,SSR,Handle hydration mismatches,Client/server content must match,ClientOnly for browser-only content,Different content server/client,<ClientOnly><BrowserWidget/></ClientOnly>,<div>{{ Date.now() }}</div>,High,
|
||||||
|
59
.claude/skills/ui-ux-pro-max/data/styles.csv
Normal file
59
.claude/skills/ui-ux-pro-max/data/styles.csv
Normal file
@ -0,0 +1,59 @@
|
|||||||
|
STT,Style Category,Type,Keywords,Primary Colors,Secondary Colors,Effects & Animation,Best For,Do Not Use For,Light Mode ✓,Dark Mode ✓,Performance,Accessibility,Mobile-Friendly,Conversion-Focused,Framework Compatibility,Era/Origin,Complexity
|
||||||
|
1,Minimalism & Swiss Style,General,"Clean, simple, spacious, functional, white space, high contrast, geometric, sans-serif, grid-based, essential","Monochromatic, Black #000000, White #FFFFFF","Neutral (Beige #F5F1E8, Grey #808080, Taupe #B38B6D), Primary accent","Subtle hover (200-250ms), smooth transitions, sharp shadows if any, clear type hierarchy, fast loading","Enterprise apps, dashboards, documentation sites, SaaS platforms, professional tools","Creative portfolios, entertainment, playful brands, artistic experiments",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,◐ Medium,"Tailwind 10/10, Bootstrap 9/10, MUI 9/10",1950s Swiss,Low
|
||||||
|
2,Neumorphism,General,"Soft UI, embossed, debossed, convex, concave, light source, subtle depth, rounded (12-16px), monochromatic","Light pastels: Soft Blue #C8E0F4, Soft Pink #F5E0E8, Soft Grey #E8E8E8","Tints/shades (±30%), gradient subtlety, color harmony","Soft box-shadow (multiple: -5px -5px 15px, 5px 5px 15px), smooth press (150ms), inner subtle shadow","Health/wellness apps, meditation platforms, fitness trackers, minimal interaction UIs","Complex apps, critical accessibility, data-heavy dashboards, high-contrast required",✓ Full,◐ Partial,⚡ Good,⚠ Low contrast,✓ Good,◐ Medium,"Tailwind 8/10, CSS-in-JS 9/10",2020s Modern,Medium
|
||||||
|
3,Glassmorphism,General,"Frosted glass, transparent, blurred background, layered, vibrant background, light source, depth, multi-layer","Translucent white: rgba(255,255,255,0.1-0.3)","Vibrant: Electric Blue #0080FF, Neon Purple #8B00FF, Vivid Pink #FF1493, Teal #20B2AA","Backdrop blur (10-20px), subtle border (1px solid rgba white 0.2), light reflection, Z-depth","Modern SaaS, financial dashboards, high-end corporate, lifestyle apps, modal overlays, navigation","Low-contrast backgrounds, critical accessibility, performance-limited, dark text on dark",✓ Full,✓ Full,⚠ Good,⚠ Ensure 4.5:1,✓ Good,✓ High,"Tailwind 9/10, MUI 8/10, Chakra 8/10",2020s Modern,Medium
|
||||||
|
4,Brutalism,General,"Raw, unpolished, stark, high contrast, plain text, default fonts, visible borders, asymmetric, anti-design","Primary: Red #FF0000, Blue #0000FF, Yellow #FFFF00, Black #000000, White #FFFFFF","Limited: Neon Green #00FF00, Hot Pink #FF00FF, minimal secondary","No smooth transitions (instant), sharp corners (0px), bold typography (700+), visible grid, large blocks","Design portfolios, artistic projects, counter-culture brands, editorial/media sites, tech blogs","Corporate environments, conservative industries, critical accessibility, customer-facing professional",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,◐ Medium,✗ Low,"Tailwind 10/10, Bootstrap 7/10",1950s Brutalist,Low
|
||||||
|
5,3D & Hyperrealism,General,"Depth, realistic textures, 3D models, spatial navigation, tactile, skeuomorphic elements, rich detail, immersive","Deep Navy #001F3F, Forest Green #228B22, Burgundy #800020, Gold #FFD700, Silver #C0C0C0","Complex gradients (5-10 stops), realistic lighting, shadow variations (20-40% darker)","WebGL/Three.js 3D, realistic shadows (layers), physics lighting, parallax (3-5 layers), smooth 3D (300-400ms)","Gaming, product showcase, immersive experiences, high-end e-commerce, architectural viz, VR/AR","Low-end mobile, performance-limited, critical accessibility, data tables/forms",◐ Partial,◐ Partial,❌ Poor,⚠ Not accessible,✗ Low,◐ Medium,"Three.js 10/10, R3F 10/10, Babylon.js 10/10",2020s Modern,High
|
||||||
|
6,Vibrant & Block-based,General,"Bold, energetic, playful, block layout, geometric shapes, high color contrast, duotone, modern, energetic","Neon Green #39FF14, Electric Purple #BF00FF, Vivid Pink #FF1493, Bright Cyan #00FFFF, Sunburst #FFAA00","Complementary: Orange #FF7F00, Shocking Pink #FF006E, Lime #CCFF00, triadic schemes","Large sections (48px+ gaps), animated patterns, bold hover (color shift), scroll-snap, large type (32px+), 200-300ms","Startups, creative agencies, gaming, social media, youth-focused, entertainment, consumer","Financial institutions, healthcare, formal business, government, conservative, elderly",✓ Full,✓ Full,⚡ Good,◐ Ensure WCAG,✓ High,✓ High,"Tailwind 10/10, Chakra 9/10, Styled 9/10",2020s Modern,Medium
|
||||||
|
7,Dark Mode (OLED),General,"Dark theme, low light, high contrast, deep black, midnight blue, eye-friendly, OLED, night mode, power efficient","Deep Black #000000, Dark Grey #121212, Midnight Blue #0A0E27","Vibrant accents: Neon Green #39FF14, Electric Blue #0080FF, Gold #FFD700, Plasma Purple #BF00FF","Minimal glow (text-shadow: 0 0 10px), dark-to-light transitions, low white emission, high readability, visible focus","Night-mode apps, coding platforms, entertainment, eye-strain prevention, OLED devices, low-light","Print-first content, high-brightness outdoor, color-accuracy-critical",✗ No,✓ Only,⚡ Excellent,✓ WCAG AAA,✓ High,◐ Low,"Tailwind 10/10, MUI 10/10, Chakra 10/10",2020s Modern,Low
|
||||||
|
8,Accessible & Ethical,General,"High contrast, large text (16px+), keyboard navigation, screen reader friendly, WCAG compliant, focus state, semantic","WCAG AA/AAA (4.5:1 min), simple primary, clear secondary, high luminosity (7:1+)","Symbol-based colors (not color-only), supporting patterns, inclusive combinations","Clear focus rings (3-4px), ARIA labels, skip links, responsive design, reduced motion, 44x44px touch targets","Government, healthcare, education, inclusive products, large audience, legal compliance, public",None - accessibility universal,✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"All frameworks 10/10",Universal,Low
|
||||||
|
9,Claymorphism,General,"Soft 3D, chunky, playful, toy-like, bubbly, thick borders (3-4px), double shadows, rounded (16-24px)","Pastel: Soft Peach #FDBCB4, Baby Blue #ADD8E6, Mint #98FF98, Lilac #E6E6FA, light BG","Soft gradients (pastel-to-pastel), light/dark variations (20-30%), gradient subtle","Inner+outer shadows (subtle, no hard lines), soft press (200ms ease-out), fluffy elements, smooth transitions","Educational apps, children's apps, SaaS platforms, creative tools, fun-focused, onboarding, casual games","Formal corporate, professional services, data-critical, serious/medical, legal apps, finance",✓ Full,◐ Partial,⚡ Good,⚠ Ensure 4.5:1,✓ High,✓ High,"Tailwind 9/10, CSS-in-JS 9/10",2020s Modern,Medium
|
||||||
|
10,Aurora UI,General,"Vibrant gradients, smooth blend, Northern Lights effect, mesh gradient, luminous, atmospheric, abstract","Complementary: Blue-Orange, Purple-Yellow, Electric Blue #0080FF, Magenta #FF1493, Cyan #00FFFF","Smooth transitions (Blue→Purple→Pink→Teal), iridescent effects, blend modes (screen, multiply)","Large flowing CSS/SVG gradients, subtle 8-12s animations, depth via color layering, smooth morph","Modern SaaS, creative agencies, branding, music platforms, lifestyle, premium products, hero sections","Data-heavy dashboards, critical accessibility, content-heavy where distraction issues",✓ Full,✓ Full,⚠ Good,⚠ Text contrast,✓ Good,✓ High,"Tailwind 9/10, CSS-in-JS 10/10",2020s Modern,Medium
|
||||||
|
11,Retro-Futurism,General,"Vintage sci-fi, 80s aesthetic, neon glow, geometric patterns, CRT scanlines, pixel art, cyberpunk, synthwave","Neon Blue #0080FF, Hot Pink #FF006E, Cyan #00FFFF, Deep Black #1A1A2E, Purple #5D34D0","Metallic Silver #C0C0C0, Gold #FFD700, duotone, 80s Pink #FF10F0, neon accents","CRT scanlines (::before overlay), neon glow (text-shadow+box-shadow), glitch effects (skew/offset keyframes)","Gaming, entertainment, music platforms, tech brands, artistic projects, nostalgic, cyberpunk","Conservative industries, critical accessibility, professional/corporate, elderly, legal/finance",✓ Full,✓ Dark focused,⚠ Moderate,⚠ High contrast/strain,◐ Medium,◐ Medium,"Tailwind 8/10, CSS-in-JS 9/10",1980s Retro,Medium
|
||||||
|
12,Flat Design,General,"2D, minimalist, bold colors, no shadows, clean lines, simple shapes, typography-focused, modern, icon-heavy","Solid bright: Red, Orange, Blue, Green, limited palette (4-6 max)","Complementary colors, muted secondaries, high saturation, clean accents","No gradients/shadows, simple hover (color/opacity shift), fast loading, clean transitions (150-200ms ease), minimal icons","Web apps, mobile apps, cross-platform, startup MVPs, user-friendly, SaaS, dashboards, corporate","Complex 3D, premium/luxury, artistic portfolios, immersive experiences, high-detail",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"Tailwind 10/10, Bootstrap 10/10, MUI 9/10",2010s Modern,Low
|
||||||
|
13,Skeuomorphism,General,"Realistic, texture, depth, 3D appearance, real-world metaphors, shadows, gradients, tactile, detailed, material","Rich realistic: wood, leather, metal colors, detailed gradients (8-12 stops), metallic effects","Realistic lighting gradients, shadow variations (30-50% darker), texture overlays, material colors","Realistic shadows (layers), depth (perspective), texture details (noise, grain), realistic animations (300-500ms)","Legacy apps, gaming, immersive storytelling, premium products, luxury, realistic simulations, education","Modern enterprise, critical accessibility, low-performance, web (use Flat/Modern)",◐ Partial,◐ Partial,❌ Poor,⚠ Textures reduce readability,✗ Low,◐ Medium,"CSS-in-JS 7/10, Custom 8/10",2007-2012 iOS,High
|
||||||
|
14,Liquid Glass,General,"Flowing glass, morphing, smooth transitions, fluid effects, translucent, animated blur, iridescent, chromatic aberration","Vibrant iridescent (rainbow spectrum), translucent base with opacity shifts, gradient fluidity","Chromatic aberration (Red-Cyan), iridescent oil-spill, fluid gradient blends, holographic effects","Morphing elements (SVG/CSS), fluid animations (400-600ms curves), dynamic blur (backdrop-filter), color transitions","Premium SaaS, high-end e-commerce, creative platforms, branding experiences, luxury portfolios","Performance-limited, critical accessibility, complex data, budget projects",✓ Full,✓ Full,⚠ Moderate-Poor,⚠ Text contrast,◐ Medium,✓ High,"Framer Motion 10/10, GSAP 10/10",2020s Modern,High
|
||||||
|
15,Motion-Driven,General,"Animation-heavy, microinteractions, smooth transitions, scroll effects, parallax, entrance anim, page transitions","Bold colors emphasize movement, high contrast animated, dynamic gradients, accent action colors","Transitional states, success (Green #22C55E), error (Red #EF4444), neutral feedback","Scroll anim (Intersection Observer), hover (300-400ms), entrance, parallax (3-5 layers), page transitions","Portfolio sites, storytelling platforms, interactive experiences, entertainment apps, creative, SaaS","Data dashboards, critical accessibility, low-power devices, content-heavy, motion-sensitive",✓ Full,✓ Full,⚠ Good,⚠ Prefers-reduced-motion,✓ Good,✓ High,"GSAP 10/10, Framer Motion 10/10",2020s Modern,High
|
||||||
|
16,Micro-interactions,General,"Small animations, gesture-based, tactile feedback, subtle animations, contextual interactions, responsive","Subtle color shifts (10-20%), feedback: Green #22C55E, Red #EF4444, Amber #F59E0B","Accent feedback, neutral supporting, clear action indicators","Small hover (50-100ms), loading spinners, success/error state anim, gesture-triggered (swipe/pinch), haptic","Mobile apps, touchscreen UIs, productivity tools, user-friendly, consumer apps, interactive components","Desktop-only, critical performance, accessibility-first (alternatives needed)",✓ Full,✓ Full,⚡ Excellent,✓ Good,✓ High,✓ High,"Framer Motion 10/10, React Spring 9/10",2020s Modern,Medium
|
||||||
|
17,Inclusive Design,General,"Accessible, color-blind friendly, high contrast, haptic feedback, voice interaction, screen reader, WCAG AAA, universal","WCAG AAA (7:1+ contrast), avoid red-green only, symbol-based indicators, high contrast primary","Supporting patterns (stripes, dots, hatch), symbols, combinations, clear non-color indicators","Haptic feedback (vibration), voice guidance, focus indicators (4px+ ring), motion options, alt content, semantic","Public services, education, healthcare, finance, government, accessible consumer, inclusive",None - accessibility universal,✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"All frameworks 10/10",Universal,Low
|
||||||
|
18,Zero Interface,General,"Minimal visible UI, voice-first, gesture-based, AI-driven, invisible controls, predictive, context-aware, ambient","Neutral backgrounds: Soft white #FAFAFA, light grey #F0F0F0, warm off-white #F5F1E8","Subtle feedback: light green, light red, minimal UI elements, soft accents","Voice recognition UI, gesture detection, AI predictions (smooth reveal), progressive disclosure, smart suggestions","Voice assistants, AI platforms, future-forward UX, smart home, contextual computing, ambient experiences","Complex workflows, data-entry heavy, traditional systems, legacy support, explicit control",✓ Full,✓ Full,⚡ Excellent,✓ Excellent,✓ High,✓ High,"Tailwind 10/10, Custom 10/10",2020s AI-Era,Low
|
||||||
|
19,Soft UI Evolution,General,"Evolved soft UI, better contrast, modern aesthetics, subtle depth, accessibility-focused, improved shadows, hybrid","Improved contrast pastels: Soft Blue #87CEEB, Soft Pink #FFB6C1, Soft Green #90EE90, better hierarchy","Better combinations, accessible secondary, supporting with improved contrast, modern accents","Improved shadows (softer than flat, clearer than neumorphism), modern (200-300ms), focus visible, WCAG AA/AAA","Modern enterprise apps, SaaS platforms, health/wellness, modern business tools, professional, hybrid","Extreme minimalism, critical performance, systems without modern OS",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA+,✓ High,✓ High,"Tailwind 9/10, MUI 9/10, Chakra 9/10",2020s Modern,Medium
|
||||||
|
20,Hero-Centric Design,Landing Page,"Large hero section, compelling headline, high-contrast CTA, product showcase, value proposition, hero image/video, dramatic visual","Brand primary color, white/light backgrounds for contrast, accent color for CTA","Supporting colors for secondary CTAs, accent highlights, trust elements (testimonials, logos)","Smooth scroll reveal, fade-in animations on hero, subtle background parallax, CTA glow/pulse effect","SaaS landing pages, product launches, service landing pages, B2B platforms, tech companies","Complex navigation, multi-page experiences, data-heavy applications",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,✓ Full,✓ Very High,"Tailwind 10/10, Bootstrap 9/10",2020s Modern,Medium
|
||||||
|
21,Conversion-Optimized,Landing Page,"Form-focused, minimalist design, single CTA focus, high contrast, urgency elements, trust signals, social proof, clear value","Primary brand color, high-contrast white/light backgrounds, warning/urgency colors for time-limited offers","Secondary CTA color (muted), trust element colors (testimonial highlights), accent for key benefits","Hover states on CTA (color shift, slight scale), form field focus animations, loading spinner, success feedback","E-commerce product pages, free trial signups, lead generation, SaaS pricing pages, limited-time offers","Complex feature explanations, multi-product showcases, technical documentation",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ Full (mobile-optimized),✓ Very High
|
||||||
|
22,Feature-Rich Showcase,Landing Page,"Multiple feature sections, grid layout, benefit cards, visual feature demonstrations, interactive elements, problem-solution pairs","Primary brand, bright secondary colors for feature cards, contrasting accent for CTAs","Supporting colors for: benefits (green), problems (red/orange), features (blue/purple), social proof (neutral)","Card hover effects (lift/scale), icon animations on scroll, feature toggle animations, smooth section transitions","Enterprise SaaS, software tools landing pages, platform services, complex product explanations, B2B products","Simple product pages, early-stage startups with few features, entertainment landing pages",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,✓ Good,✓ High
|
||||||
|
23,Minimal & Direct,Landing Page,"Minimal text, white space heavy, single column layout, direct messaging, clean typography, visual-centric, fast-loading","Monochromatic primary, white background, single accent color for CTA, black/dark grey text","Minimal secondary colors, reserved for critical CTAs only, neutral supporting elements","Very subtle hover effects, minimal animations, fast page load (no heavy animations), smooth scroll","Simple service landing pages, indie products, consulting services, micro SaaS, freelancer portfolios","Feature-heavy products, complex explanations, multi-product showcases",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ Full,✓ High
|
||||||
|
24,Social Proof-Focused,Landing Page,"Testimonials prominent, client logos displayed, case studies sections, reviews/ratings, user avatars, success metrics, credibility markers","Primary brand, trust colors (blue), success/growth colors (green), neutral backgrounds","Testimonial highlight colors, logo grid backgrounds (light grey), badge/achievement colors","Testimonial carousel animations, logo grid fade-in, stat counter animations (number count-up), review star ratings","B2B SaaS, professional services, premium products, e-commerce conversion pages, established brands","Startup MVPs, products without users, niche/experimental products",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,✓ Full,✓ High
|
||||||
|
25,Interactive Product Demo,Landing Page,"Embedded product mockup/video, interactive elements, product walkthrough, step-by-step guides, hover-to-reveal features, embedded demos","Primary brand, interface colors matching product, demo highlight colors for interactive elements","Product UI colors, tutorial step colors (numbered progression), hover state indicators","Product animation playback, step progression animations, hover reveal effects, smooth zoom on interaction","SaaS platforms, tool/software products, productivity apps landing pages, developer tools, productivity software","Simple services, consulting, non-digital products, complexity-averse audiences",✓ Full,✓ Full,⚠ Good (video/interactive),✓ WCAG AA,✓ Good,✓ Very High
|
||||||
|
26,Trust & Authority,Landing Page,"Certificates/badges displayed, expert credentials, case studies with metrics, before/after comparisons, industry recognition, security badges","Professional colors (blue/grey), trust colors, certification badge colors (gold/silver accents)","Certificate highlight colors, metric showcase colors, comparison highlight (success green)","Badge hover effects, metric pulse animations, certificate carousel, smooth stat reveal","Healthcare/medical landing pages, financial services, enterprise software, premium/luxury products, legal services","Casual products, entertainment, viral/social-first products",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ Full,✓ High
|
||||||
|
27,Storytelling-Driven,Landing Page,"Narrative flow, visual story progression, section transitions, consistent character/brand voice, emotional messaging, journey visualization","Brand primary, warm/emotional colors, varied accent colors per story section, high visual variety","Story section color coding, emotional state colors (calm, excitement, success), transitional gradients","Section-to-section animations, scroll-triggered reveals, character/icon animations, morphing transitions, parallax narrative","Brand/startup stories, mission-driven products, premium/lifestyle brands, documentary-style products, educational","Technical/complex products (unless narrative-driven), traditional enterprise software",✓ Full,✓ Full,⚠ Moderate (animations),✓ WCAG AA,✓ Good,✓ High
|
||||||
|
28,Data-Dense Dashboard,BI/Analytics,"Multiple charts/widgets, data tables, KPI cards, minimal padding, grid layout, space-efficient, maximum data visibility","Neutral primary (light grey/white #F5F5F5), data colors (blue/green/red), dark text #333333","Chart colors: success (green #22C55E), warning (amber #F59E0B), alert (red #EF4444), neutral (grey)","Hover tooltips, chart zoom on click, row highlighting on hover, smooth filter animations, data loading spinners","Business intelligence dashboards, financial analytics, enterprise reporting, operational dashboards, data warehousing","Marketing dashboards, consumer-facing analytics, simple reporting",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,◐ Medium,✗ Not applicable
|
||||||
|
29,Heat Map & Heatmap Style,BI/Analytics,"Color-coded grid/matrix, data intensity visualization, geographical heat maps, correlation matrices, cell-based representation, gradient coloring","Gradient scale: Cool (blue #0080FF) to hot (red #FF0000), neutral middle (white/yellow)","Support gradients: Light (cool blue) to dark (warm red), divergent for positive/negative data, monochromatic options","Color gradient transitions on data change, cell highlighting on hover, tooltip reveal on click, smooth color animation","Geographical analysis, performance matrices, correlation analysis, user behavior heatmaps, temperature/intensity data","Linear data representation, categorical comparisons (use bar charts), small datasets",✓ Full,✓ Full (with adjustments),⚡ Excellent,⚠ Colorblind considerations,◐ Medium,✗ Not applicable
|
||||||
|
30,Executive Dashboard,BI/Analytics,"High-level KPIs, large key metrics, minimal detail, summary view, trend indicators, at-a-glance insights, executive summary","Brand colors, professional palette (blue/grey/white), accent for KPIs, red for alerts/concerns","KPI highlight colors: positive (green), negative (red), neutral (grey), trend arrow colors","KPI value animations (count-up), trend arrow direction animations, metric card hover lift, alert pulse effect","C-suite dashboards, business summary reports, decision-maker dashboards, strategic planning views","Detailed analyst dashboards, technical deep-dives, operational monitoring",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✗ Low (not mobile-optimized),✗ Not applicable
|
||||||
|
31,Real-Time Monitoring,BI/Analytics,"Live data updates, status indicators, alert notifications, streaming data visualization, active monitoring, streaming charts","Alert colors: critical (red #FF0000), warning (orange #FFA500), normal (green #22C55E), updating (blue animation)","Status indicator colors, chart line colors varying by metric, streaming data highlight colors","Real-time chart animations, alert pulse/glow, status indicator blink animation, smooth data stream updates, loading effect","System monitoring dashboards, DevOps dashboards, real-time analytics, stock market dashboards, live event tracking","Historical analysis, long-term trend reports, archived data dashboards",✓ Full,✓ Full,⚡ Good (real-time load),✓ WCAG AA,◐ Medium,✗ Not applicable
|
||||||
|
32,Drill-Down Analytics,BI/Analytics,"Hierarchical data exploration, expandable sections, interactive drill-down paths, summary-to-detail flow, context preservation","Primary brand, breadcrumb colors, drill-level indicator colors, hierarchy depth colors","Drill-down path indicator colors, level-specific colors, highlight colors for selected level, transition colors","Drill-down expand animations, breadcrumb click transitions, smooth detail reveal, level change smooth, data reload animation","Sales analytics, product analytics, funnel analysis, multi-dimensional data exploration, business intelligence","Simple linear data, single-metric dashboards, streaming real-time dashboards",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,◐ Medium,✗ Not applicable
|
||||||
|
33,Comparative Analysis Dashboard,BI/Analytics,"Side-by-side comparisons, period-over-period metrics, A/B test results, regional comparisons, performance benchmarks","Comparison colors: primary (blue), comparison (orange/purple), delta indicator (green/red)","Winning metric color (green), losing metric color (red), neutral comparison (grey), benchmark colors","Comparison bar animations (grow to value), delta indicator animations (direction arrows), highlight on compare","Period-over-period reporting, A/B test dashboards, market comparison, competitive analysis, regional performance","Single metric dashboards, future projections (use forecasting), real-time only (no historical)",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,◐ Medium,✗ Not applicable
|
||||||
|
34,Predictive Analytics,BI/Analytics,"Forecast lines, confidence intervals, trend projections, scenario modeling, AI-driven insights, anomaly detection visualization","Forecast line color (distinct from actual), confidence interval shading, anomaly highlight (red alert), trend colors","High confidence (dark color), low confidence (light color), anomaly colors (red/orange), normal trend (green/blue)","Forecast line animation on draw, confidence band fade-in, anomaly pulse alert, smoothing function animations","Forecasting dashboards, anomaly detection systems, trend prediction dashboards, AI-powered analytics, budget planning","Historical-only dashboards, simple reporting, real-time operational dashboards",✓ Full,✓ Full,⚠ Good (computation),✓ WCAG AA,◐ Medium,✗ Not applicable
|
||||||
|
35,User Behavior Analytics,BI/Analytics,"Funnel visualization, user flow diagrams, conversion tracking, engagement metrics, user journey mapping, cohort analysis","Funnel stage colors: high engagement (green), drop-off (red), conversion (blue), user flow arrows (grey)","Stage completion colors (success), abandonment colors (warning), engagement levels (gradient), cohort colors","Funnel animation (fill-down), flow diagram animations (connection draw), conversion pulse, engagement bar fill","Conversion funnel analysis, user journey tracking, engagement analytics, cohort analysis, retention tracking","Real-time operational metrics, technical system monitoring, financial transactions",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,✓ Good,✗ Not applicable
|
||||||
|
36,Financial Dashboard,BI/Analytics,"Revenue metrics, profit/loss visualization, budget tracking, financial ratios, portfolio performance, cash flow, audit trail","Financial colors: profit (green #22C55E), loss (red #EF4444), neutral (grey), trust (dark blue #003366)","Revenue highlight (green), expenses (red), budget variance (orange/red), balance (grey), accuracy (blue)","Number animations (count-up), trend direction indicators, percentage change animations, profit/loss color transitions","Financial reporting, accounting dashboards, portfolio tracking, budget monitoring, banking analytics","Simple business dashboards, entertainment/social metrics, non-financial data",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✗ Low,✗ Not applicable
|
||||||
|
37,Sales Intelligence Dashboard,BI/Analytics,"Deal pipeline, sales metrics, territory performance, sales rep leaderboard, win-loss analysis, quota tracking, forecast accuracy","Sales colors: won (green), lost (red), in-progress (blue), blocked (orange), quota met (gold), quota missed (grey)","Pipeline stage colors, rep performance colors, quota achievement colors, forecast accuracy colors","Deal movement animations, metric updates, leaderboard ranking changes, gauge needle movements, status change highlights","CRM dashboards, sales management, opportunity tracking, performance management, quota planning","Marketing analytics, customer support metrics, HR dashboards",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,◐ Medium,✗ Not applicable,"Recharts 9/10, Chart.js 9/10",2020s Modern,Medium
|
||||||
|
38,Neubrutalism,General,"Bold borders, black outlines, primary colors, thick shadows, no gradients, flat colors, 45° shadows, playful, Gen Z","#FFEB3B (Yellow), #FF5252 (Red), #2196F3 (Blue), #000000 (Black borders)","Limited accent colors, high contrast combinations, no gradients allowed","box-shadow: 4px 4px 0 #000, border: 3px solid #000, no gradients, sharp corners (0px), bold typography","Gen Z brands, startups, creative agencies, Figma-style apps, Notion-style interfaces, tech blogs","Luxury brands, finance, healthcare, conservative industries (too playful)",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"Tailwind 10/10, Bootstrap 8/10",2020s Modern,Low
|
||||||
|
39,Bento Box Grid,General,"Modular cards, asymmetric grid, varied sizes, Apple-style, dashboard tiles, negative space, clean hierarchy, cards","Neutral base + brand accent, #FFFFFF, #F5F5F5, brand primary","Subtle gradients, shadow variations, accent highlights for interactive cards","grid-template with varied spans, rounded-xl (16px), subtle shadows, hover scale (1.02), smooth transitions","Dashboards, product pages, portfolios, Apple-style marketing, feature showcases, SaaS","Dense data tables, text-heavy content, real-time monitoring",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"Tailwind 10/10, CSS Grid 10/10",2020s Apple,Low
|
||||||
|
40,Y2K Aesthetic,General,"Neon pink, chrome, metallic, bubblegum, iridescent, glossy, retro-futurism, 2000s, futuristic nostalgia","#FF69B4 (Hot Pink), #00FFFF (Cyan), #C0C0C0 (Silver), #9400D3 (Purple)","Metallic gradients, glossy overlays, iridescent effects, chrome textures","linear-gradient metallic, glossy buttons, 3D chrome effects, glow animations, bubble shapes","Fashion brands, music platforms, Gen Z brands, nostalgia marketing, entertainment, youth-focused","B2B enterprise, healthcare, finance, conservative industries, elderly users",✓ Full,◐ Partial,⚠ Good,⚠ Check contrast,✓ Good,✓ High,"Tailwind 8/10, CSS-in-JS 9/10",Y2K 2000s,Medium
|
||||||
|
41,Cyberpunk UI,General,"Neon, dark mode, terminal, HUD, sci-fi, glitch, dystopian, futuristic, matrix, tech noir","#00FF00 (Matrix Green), #FF00FF (Magenta), #00FFFF (Cyan), #0D0D0D (Dark)","Neon gradients, scanline overlays, glitch colors, terminal green accents","Neon glow (text-shadow), glitch animations (skew/offset), scanlines (::before overlay), terminal fonts","Gaming platforms, tech products, crypto apps, sci-fi applications, developer tools, entertainment","Corporate enterprise, healthcare, family apps, conservative brands, elderly users",✗ No,✓ Only,⚠ Moderate,⚠ Limited (dark+neon),◐ Medium,◐ Medium,"Tailwind 8/10, Custom CSS 10/10",2020s Cyberpunk,Medium
|
||||||
|
42,Organic Biophilic,General,"Nature, organic shapes, green, sustainable, rounded, flowing, wellness, earthy, natural textures","#228B22 (Forest Green), #8B4513 (Earth Brown), #87CEEB (Sky Blue), #F5F5DC (Beige)","Natural gradients, earth tones, sky blues, organic textures, wood/stone colors","Rounded corners (16-24px), organic curves (border-radius variations), natural shadows, flowing SVG shapes","Wellness apps, sustainability brands, eco products, health apps, meditation, organic food brands","Tech-focused products, gaming, industrial, urban brands",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"Tailwind 10/10, CSS 10/10",2020s Sustainable,Low
|
||||||
|
43,AI-Native UI,General,"Chatbot, conversational, voice, assistant, agentic, ambient, minimal chrome, streaming text, AI interactions","Neutral + single accent, #6366F1 (AI Purple), #10B981 (Success), #F5F5F5 (Background)","Status indicators, streaming highlights, context card colors, subtle accent variations","Typing indicators (3-dot pulse), streaming text animations, pulse animations, context cards, smooth reveals","AI products, chatbots, voice assistants, copilots, AI-powered tools, conversational interfaces","Traditional forms, data-heavy dashboards, print-first content",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"Tailwind 10/10, React 10/10",2020s AI-Era,Low
|
||||||
|
44,Memphis Design,General,"80s, geometric, playful, postmodern, shapes, patterns, squiggles, triangles, neon, abstract, bold","#FF71CE (Hot Pink), #FFCE5C (Yellow), #86CCCA (Teal), #6A7BB4 (Blue Purple)","Complementary geometric colors, pattern fills, contrasting accent shapes","transform: rotate(), clip-path: polygon(), mix-blend-mode, repeating patterns, bold shapes","Creative agencies, music sites, youth brands, event promotion, artistic portfolios, entertainment","Corporate finance, healthcare, legal, elderly users, conservative brands",✓ Full,✓ Full,⚡ Excellent,⚠ Check contrast,✓ Good,◐ Medium,"Tailwind 9/10, CSS 10/10",1980s Postmodern,Medium
|
||||||
|
45,Vaporwave,General,"Synthwave, retro-futuristic, 80s-90s, neon, glitch, nostalgic, sunset gradient, dreamy, aesthetic","#FF71CE (Pink), #01CDFE (Cyan), #05FFA1 (Mint), #B967FF (Purple)","Sunset gradients, glitch overlays, VHS effects, neon accents, pastel variations","text-shadow glow, linear-gradient, filter: hue-rotate(), glitch animations, retro scan lines","Music platforms, gaming, creative portfolios, tech startups, entertainment, artistic projects","Business apps, e-commerce, education, healthcare, enterprise software",✓ Full,✓ Dark focused,⚠ Moderate,⚠ Poor (motion),◐ Medium,◐ Medium,"Tailwind 8/10, CSS-in-JS 9/10",1980s-90s Retro,Medium
|
||||||
|
46,Dimensional Layering,General,"Depth, overlapping, z-index, layers, 3D, shadows, elevation, floating, cards, spatial hierarchy","Neutral base (#FFFFFF, #F5F5F5, #E0E0E0) + brand accent for elevated elements","Shadow variations (sm/md/lg/xl), elevation colors, highlight colors for top layers","z-index stacking, box-shadow elevation (4 levels), transform: translateZ(), backdrop-filter, parallax","Dashboards, card layouts, modals, navigation, product showcases, SaaS interfaces","Print-style layouts, simple blogs, low-end devices, flat design requirements",✓ Full,✓ Full,⚠ Good,⚠ Moderate (SR issues),✓ Good,✓ High,"Tailwind 10/10, MUI 10/10, Chakra 10/10",2020s Modern,Medium
|
||||||
|
47,Exaggerated Minimalism,General,"Bold minimalism, oversized typography, high contrast, negative space, loud minimal, statement design","#000000 (Black), #FFFFFF (White), single vibrant accent only","Minimal - single accent color, no secondary colors, extreme restraint","font-size: clamp(3rem 10vw 12rem), font-weight: 900, letter-spacing: -0.05em, massive whitespace","Fashion, architecture, portfolios, agency landing pages, luxury brands, editorial","E-commerce catalogs, dashboards, forms, data-heavy, elderly users, complex apps",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"Tailwind 10/10, Typography.js 10/10",2020s Modern,Low
|
||||||
|
48,Kinetic Typography,General,"Motion text, animated type, moving letters, dynamic, typing effect, morphing, scroll-triggered text","Flexible - high contrast recommended, bold colors for emphasis, animation-friendly palette","Accent colors for emphasis, transition colors, gradient text fills","@keyframes text animation, typing effect, background-clip: text, GSAP ScrollTrigger, split text","Hero sections, marketing sites, video platforms, storytelling, creative portfolios, landing pages","Long-form content, accessibility-critical, data interfaces, forms, elderly users",✓ Full,✓ Full,⚠ Moderate,❌ Poor (motion),✓ Good,✓ Very High,"GSAP 10/10, Framer Motion 10/10",2020s Modern,High
|
||||||
|
49,Parallax Storytelling,General,"Scroll-driven, narrative, layered scrolling, immersive, progressive disclosure, cinematic, scroll-triggered","Story-dependent, often gradients and natural colors, section-specific palettes","Section transition colors, depth layer colors, narrative mood colors","transform: translateY(scroll), position: fixed/sticky, perspective: 1px, scroll-triggered animations","Brand storytelling, product launches, case studies, portfolios, annual reports, marketing campaigns","E-commerce, dashboards, mobile-first, SEO-critical, accessibility-required",✓ Full,✓ Full,❌ Poor,❌ Poor (motion),✗ Low,✓ High,"GSAP ScrollTrigger 10/10, Locomotive Scroll 10/10",2020s Modern,High
|
||||||
|
50,Swiss Modernism 2.0,General,"Grid system, Helvetica, modular, asymmetric, international style, rational, clean, mathematical spacing","#000000, #FFFFFF, #F5F5F5, single vibrant accent only","Minimal secondary, accent for emphasis only, no gradients","display: grid, grid-template-columns: repeat(12 1fr), gap: 1rem, mathematical ratios, clear hierarchy","Corporate sites, architecture, editorial, SaaS, museums, professional services, documentation","Playful brands, children's sites, entertainment, gaming, emotional storytelling",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"Tailwind 10/10, Bootstrap 9/10, Foundation 10/10",1950s Swiss + 2020s,Low
|
||||||
|
51,HUD / Sci-Fi FUI,General,"Futuristic, technical, wireframe, neon, data, transparency, iron man, sci-fi, interface","Neon Cyan #00FFFF, Holographic Blue #0080FF, Alert Red #FF0000","Transparent Black, Grid Lines #333333","Glow effects, scanning animations, ticker text, blinking markers, fine line drawing","Sci-fi games, space tech, cybersecurity, movie props, immersive dashboards","Standard corporate, reading heavy content, accessible public services",✓ Low,✓ Full,⚠ Moderate (renders),⚠ Poor (thin lines),◐ Medium,✗ Low,"React 9/10, Canvas 10/10",2010s Sci-Fi,High
|
||||||
|
52,Pixel Art,General,"Retro, 8-bit, 16-bit, gaming, blocky, nostalgic, pixelated, arcade","Primary colors (NES Palette), brights, limited palette","Black outlines, shading via dithering or block colors","Frame-by-frame sprite animation, blinking cursor, instant transitions, marquee text","Indie games, retro tools, creative portfolios, nostalgia marketing, Web3/NFT","Professional corporate, modern SaaS, high-res photography sites",✓ Full,✓ Full,⚡ Excellent,✓ Good (if contrast ok),✓ High,◐ Medium,"CSS (box-shadow) 8/10, Canvas 10/10",1980s Arcade,Medium
|
||||||
|
53,Bento Grids,General,"Apple-style, modular, cards, organized, clean, hierarchy, grid, rounded, soft","Off-white #F5F5F7, Clean White #FFFFFF, Text #1D1D1F","Subtle accents, soft shadows, blurred backdrops","Hover scale (1.02), soft shadow expansion, smooth layout shifts, content reveal","Product features, dashboards, personal sites, marketing summaries, galleries","Long-form reading, data tables, complex forms",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"CSS Grid 10/10, Tailwind 10/10",2020s Apple/Linear,Low
|
||||||
|
54,Neubrutalism,General,"Bold, ugly-cute, raw, high contrast, flat, hard shadows, distinct, playful, loud","Pop Yellow #FFDE59, Bright Red #FF5757, Black #000000","Lavender #CBA6F7, Mint #76E0C2","Hard hover shifts (4px), marquee scrolling, jitter animations, bold borders","Design tools, creative agencies, Gen Z brands, personal blogs, gumroad-style","Banking, legal, healthcare, serious enterprise, elderly users",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"Tailwind 10/10, Plain CSS 10/10",2020s Modern Retro,Low
|
||||||
|
55,Spatial UI (VisionOS),General,"Glass, depth, immersion, spatial, translucent, gaze, gesture, apple, vision-pro","Frosted Glass #FFFFFF (15-30% opacity), System White","Vibrant system colors for active states, deep shadows for depth","Parallax depth, dynamic lighting response, gaze-hover effects, smooth scale on focus","Spatial computing apps, VR/AR interfaces, immersive media, futuristic dashboards","Text-heavy documents, high-contrast requirements, non-3D capable devices",✓ Full,✓ Full,⚠ Moderate (blur cost),⚠ Contrast risks,✓ High (if adapted),✓ High,"SwiftUI, React (Three.js/Fiber)",2024 Spatial Era,High
|
||||||
|
56,E-Ink / Paper,General,"Paper-like, matte, high contrast, texture, reading, calm, slow tech, monochrome","Off-White #FDFBF7, Paper White #F5F5F5, Ink Black #1A1A1A","Pencil Grey #4A4A4A, Highlighter Yellow #FFFF00 (accent)","No motion blur, distinct page turns, grain/noise texture, sharp transitions (no fade)","Reading apps, digital newspapers, minimal journals, distraction-free writing, slow-living brands","Gaming, video platforms, high-energy marketing, dark mode dependent apps",✓ Full,✗ Low (inverted only),⚡ Excellent,✓ WCAG AAA,✓ High,✓ Medium,"Tailwind 10/10, CSS 10/10",2020s Digital Well-being,Low
|
||||||
|
57,Gen Z Chaos / Maximalism,General,"Chaos, clutter, stickers, raw, collage, mixed media, loud, internet culture, ironic","Clashing Brights: #FF00FF, #00FF00, #FFFF00, #0000FF","Gradients, rainbow, glitch, noise, heavily saturated mix","Marquee scrolls, jitter, sticker layering, GIF overload, random placement, drag-and-drop","Gen Z lifestyle brands, music artists, creative portfolios, viral marketing, fashion","Corporate, government, healthcare, banking, serious tools",✓ Full,✓ Full,⚠ Poor (heavy assets),❌ Poor,◐ Medium,✓ High (Viral),CSS-in-JS 8/10,2023+ Internet Core,High
|
||||||
|
58,Biomimetic / Organic 2.0,General,"Nature-inspired, cellular, fluid, breathing, generative, algorithms, life-like","Cellular Pink #FF9999, Chlorophyll Green #00FF41, Bioluminescent Blue","Deep Ocean #001E3C, Coral #FF7F50, Organic gradients","Breathing animations, fluid morphing, generative growth, physics-based movement","Sustainability tech, biotech, advanced health, meditation, generative art platforms","Standard SaaS, data grids, strict corporate, accounting",✓ Full,✓ Full,⚠ Moderate,✓ Good,✓ Good,✓ High,"Canvas 10/10, WebGL 10/10",2024+ Generative,High
|
||||||
|
Can't render this file because it has a wrong number of fields in line 22.
|
58
.claude/skills/ui-ux-pro-max/data/typography.csv
Normal file
58
.claude/skills/ui-ux-pro-max/data/typography.csv
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
STT,Font Pairing Name,Category,Heading Font,Body Font,Mood/Style Keywords,Best For,Google Fonts URL,CSS Import,Tailwind Config,Notes
|
||||||
|
1,Classic Elegant,"Serif + Sans",Playfair Display,Inter,"elegant, luxury, sophisticated, timeless, premium, editorial","Luxury brands, fashion, spa, beauty, editorial, magazines, high-end e-commerce","https://fonts.google.com/share?selection.family=Inter:wght@300;400;500;600;700|Playfair+Display:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=Playfair+Display:wght@400;500;600;700&display=swap');","fontFamily: { serif: ['Playfair Display', 'serif'], sans: ['Inter', 'sans-serif'] }","High contrast between elegant heading and clean body. Perfect for luxury/premium."
|
||||||
|
2,Modern Professional,"Sans + Sans",Poppins,Open Sans,"modern, professional, clean, corporate, friendly, approachable","SaaS, corporate sites, business apps, startups, professional services","https://fonts.google.com/share?selection.family=Open+Sans:wght@300;400;500;600;700|Poppins:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;400;500;600;700&family=Poppins:wght@400;500;600;700&display=swap');","fontFamily: { heading: ['Poppins', 'sans-serif'], body: ['Open Sans', 'sans-serif'] }","Geometric Poppins for headings, humanist Open Sans for readability."
|
||||||
|
3,Tech Startup,"Sans + Sans",Space Grotesk,DM Sans,"tech, startup, modern, innovative, bold, futuristic","Tech companies, startups, SaaS, developer tools, AI products","https://fonts.google.com/share?selection.family=DM+Sans:wght@400;500;700|Space+Grotesk:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;700&family=Space+Grotesk:wght@400;500;600;700&display=swap');","fontFamily: { heading: ['Space Grotesk', 'sans-serif'], body: ['DM Sans', 'sans-serif'] }","Space Grotesk has unique character, DM Sans is highly readable."
|
||||||
|
4,Editorial Classic,"Serif + Serif",Cormorant Garamond,Libre Baskerville,"editorial, classic, literary, traditional, refined, bookish","Publishing, blogs, news sites, literary magazines, book covers","https://fonts.google.com/share?selection.family=Cormorant+Garamond:wght@400;500;600;700|Libre+Baskerville:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Cormorant+Garamond:wght@400;500;600;700&family=Libre+Baskerville:wght@400;700&display=swap');","fontFamily: { heading: ['Cormorant Garamond', 'serif'], body: ['Libre Baskerville', 'serif'] }","All-serif pairing for traditional editorial feel."
|
||||||
|
5,Minimal Swiss,"Sans + Sans",Inter,Inter,"minimal, clean, swiss, functional, neutral, professional","Dashboards, admin panels, documentation, enterprise apps, design systems","https://fonts.google.com/share?selection.family=Inter:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&display=swap');","fontFamily: { sans: ['Inter', 'sans-serif'] }","Single font family with weight variations. Ultimate simplicity."
|
||||||
|
6,Playful Creative,"Display + Sans",Fredoka,Nunito,"playful, friendly, fun, creative, warm, approachable","Children's apps, educational, gaming, creative tools, entertainment","https://fonts.google.com/share?selection.family=Fredoka:wght@400;500;600;700|Nunito:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Fredoka:wght@400;500;600;700&family=Nunito:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Fredoka', 'sans-serif'], body: ['Nunito', 'sans-serif'] }","Rounded, friendly fonts perfect for playful UIs."
|
||||||
|
7,Bold Statement,"Display + Sans",Bebas Neue,Source Sans 3,"bold, impactful, strong, dramatic, modern, headlines","Marketing sites, portfolios, agencies, event pages, sports","https://fonts.google.com/share?selection.family=Bebas+Neue|Source+Sans+3:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Bebas+Neue&family=Source+Sans+3:wght@300;400;500;600;700&display=swap');","fontFamily: { display: ['Bebas Neue', 'sans-serif'], body: ['Source Sans 3', 'sans-serif'] }","Bebas Neue for large headlines only. All-caps display font."
|
||||||
|
8,Wellness Calm,"Serif + Sans",Lora,Raleway,"calm, wellness, health, relaxing, natural, organic","Health apps, wellness, spa, meditation, yoga, organic brands","https://fonts.google.com/share?selection.family=Lora:wght@400;500;600;700|Raleway:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Lora:wght@400;500;600;700&family=Raleway:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Lora', 'serif'], sans: ['Raleway', 'sans-serif'] }","Lora's organic curves with Raleway's elegant simplicity."
|
||||||
|
9,Developer Mono,"Mono + Sans",JetBrains Mono,IBM Plex Sans,"code, developer, technical, precise, functional, hacker","Developer tools, documentation, code editors, tech blogs, CLI apps","https://fonts.google.com/share?selection.family=IBM+Plex+Sans:wght@300;400;500;600;700|JetBrains+Mono:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500;600;700&display=swap');","fontFamily: { mono: ['JetBrains Mono', 'monospace'], sans: ['IBM Plex Sans', 'sans-serif'] }","JetBrains for code, IBM Plex for UI. Developer-focused."
|
||||||
|
10,Retro Vintage,"Display + Serif",Abril Fatface,Merriweather,"retro, vintage, nostalgic, dramatic, decorative, bold","Vintage brands, breweries, restaurants, creative portfolios, posters","https://fonts.google.com/share?selection.family=Abril+Fatface|Merriweather:wght@300;400;700","@import url('https://fonts.googleapis.com/css2?family=Abril+Fatface&family=Merriweather:wght@300;400;700&display=swap');","fontFamily: { display: ['Abril Fatface', 'serif'], body: ['Merriweather', 'serif'] }","Abril Fatface for hero headlines only. High-impact vintage feel."
|
||||||
|
11,Geometric Modern,"Sans + Sans",Outfit,Work Sans,"geometric, modern, clean, balanced, contemporary, versatile","General purpose, portfolios, agencies, modern brands, landing pages","https://fonts.google.com/share?selection.family=Outfit:wght@300;400;500;600;700|Work+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Outfit:wght@300;400;500;600;700&family=Work+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Outfit', 'sans-serif'], body: ['Work Sans', 'sans-serif'] }","Both geometric but Outfit more distinctive for headings."
|
||||||
|
12,Luxury Serif,"Serif + Sans",Cormorant,Montserrat,"luxury, high-end, fashion, elegant, refined, premium","Fashion brands, luxury e-commerce, jewelry, high-end services","https://fonts.google.com/share?selection.family=Cormorant:wght@400;500;600;700|Montserrat:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Cormorant:wght@400;500;600;700&family=Montserrat:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Cormorant', 'serif'], sans: ['Montserrat', 'sans-serif'] }","Cormorant's elegance with Montserrat's geometric precision."
|
||||||
|
13,Friendly SaaS,"Sans + Sans",Plus Jakarta Sans,Plus Jakarta Sans,"friendly, modern, saas, clean, approachable, professional","SaaS products, web apps, dashboards, B2B, productivity tools","https://fonts.google.com/share?selection.family=Plus+Jakarta+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Plus+Jakarta+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { sans: ['Plus Jakarta Sans', 'sans-serif'] }","Single versatile font. Modern alternative to Inter."
|
||||||
|
14,News Editorial,"Serif + Sans",Newsreader,Roboto,"news, editorial, journalism, trustworthy, readable, informative","News sites, blogs, magazines, journalism, content-heavy sites","https://fonts.google.com/share?selection.family=Newsreader:wght@400;500;600;700|Roboto:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Newsreader:wght@400;500;600;700&family=Roboto:wght@300;400;500;700&display=swap');","fontFamily: { serif: ['Newsreader', 'serif'], sans: ['Roboto', 'sans-serif'] }","Newsreader designed for long-form reading. Roboto for UI."
|
||||||
|
15,Handwritten Charm,"Script + Sans",Caveat,Quicksand,"handwritten, personal, friendly, casual, warm, charming","Personal blogs, invitations, creative portfolios, lifestyle brands","https://fonts.google.com/share?selection.family=Caveat:wght@400;500;600;700|Quicksand:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Caveat:wght@400;500;600;700&family=Quicksand:wght@300;400;500;600;700&display=swap');","fontFamily: { script: ['Caveat', 'cursive'], sans: ['Quicksand', 'sans-serif'] }","Use Caveat sparingly for accents. Quicksand for body."
|
||||||
|
16,Corporate Trust,"Sans + Sans",Lexend,Source Sans 3,"corporate, trustworthy, accessible, readable, professional, clean","Enterprise, government, healthcare, finance, accessibility-focused","https://fonts.google.com/share?selection.family=Lexend:wght@300;400;500;600;700|Source+Sans+3:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Lexend:wght@300;400;500;600;700&family=Source+Sans+3:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Lexend', 'sans-serif'], body: ['Source Sans 3', 'sans-serif'] }","Lexend designed for readability. Excellent accessibility."
|
||||||
|
17,Brutalist Raw,"Mono + Mono",Space Mono,Space Mono,"brutalist, raw, technical, monospace, minimal, stark","Brutalist designs, developer portfolios, experimental, tech art","https://fonts.google.com/share?selection.family=Space+Mono:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Space+Mono:wght@400;700&display=swap');","fontFamily: { mono: ['Space Mono', 'monospace'] }","All-mono for raw brutalist aesthetic. Limited weights."
|
||||||
|
18,Fashion Forward,"Sans + Sans",Syne,Manrope,"fashion, avant-garde, creative, bold, artistic, edgy","Fashion brands, creative agencies, art galleries, design studios","https://fonts.google.com/share?selection.family=Manrope:wght@300;400;500;600;700|Syne:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Manrope:wght@300;400;500;600;700&family=Syne:wght@400;500;600;700&display=swap');","fontFamily: { heading: ['Syne', 'sans-serif'], body: ['Manrope', 'sans-serif'] }","Syne's unique character for headlines. Manrope for readability."
|
||||||
|
19,Soft Rounded,"Sans + Sans",Varela Round,Nunito Sans,"soft, rounded, friendly, approachable, warm, gentle","Children's products, pet apps, friendly brands, wellness, soft UI","https://fonts.google.com/share?selection.family=Nunito+Sans:wght@300;400;500;600;700|Varela+Round","@import url('https://fonts.googleapis.com/css2?family=Nunito+Sans:wght@300;400;500;600;700&family=Varela+Round&display=swap');","fontFamily: { heading: ['Varela Round', 'sans-serif'], body: ['Nunito Sans', 'sans-serif'] }","Both rounded and friendly. Perfect for soft UI designs."
|
||||||
|
20,Premium Sans,"Sans + Sans",Satoshi,General Sans,"premium, modern, clean, sophisticated, versatile, balanced","Premium brands, modern agencies, SaaS, portfolios, startups","https://fonts.google.com/share?selection.family=DM+Sans:wght@400;500;700","@import url('https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;700&display=swap');","fontFamily: { sans: ['DM Sans', 'sans-serif'] }","Note: Satoshi/General Sans on Fontshare. DM Sans as Google alternative."
|
||||||
|
21,Vietnamese Friendly,"Sans + Sans",Be Vietnam Pro,Noto Sans,"vietnamese, international, readable, clean, multilingual, accessible","Vietnamese sites, multilingual apps, international products","https://fonts.google.com/share?selection.family=Be+Vietnam+Pro:wght@300;400;500;600;700|Noto+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Be+Vietnam+Pro:wght@300;400;500;600;700&family=Noto+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { sans: ['Be Vietnam Pro', 'Noto Sans', 'sans-serif'] }","Be Vietnam Pro excellent Vietnamese support. Noto as fallback."
|
||||||
|
22,Japanese Elegant,"Serif + Sans",Noto Serif JP,Noto Sans JP,"japanese, elegant, traditional, modern, multilingual, readable","Japanese sites, Japanese restaurants, cultural sites, anime/manga","https://fonts.google.com/share?selection.family=Noto+Sans+JP:wght@300;400;500;700|Noto+Serif+JP:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+JP:wght@300;400;500;700&family=Noto+Serif+JP:wght@400;500;600;700&display=swap');","fontFamily: { serif: ['Noto Serif JP', 'serif'], sans: ['Noto Sans JP', 'sans-serif'] }","Noto fonts excellent Japanese support. Traditional + modern feel."
|
||||||
|
23,Korean Modern,"Sans + Sans",Noto Sans KR,Noto Sans KR,"korean, modern, clean, professional, multilingual, readable","Korean sites, K-beauty, K-pop, Korean businesses, multilingual","https://fonts.google.com/share?selection.family=Noto+Sans+KR:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+KR:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Noto Sans KR', 'sans-serif'] }","Clean Korean typography. Single font with weight variations."
|
||||||
|
24,Chinese Traditional,"Serif + Sans",Noto Serif TC,Noto Sans TC,"chinese, traditional, elegant, cultural, multilingual, readable","Traditional Chinese sites, cultural content, Taiwan/Hong Kong markets","https://fonts.google.com/share?selection.family=Noto+Sans+TC:wght@300;400;500;700|Noto+Serif+TC:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+TC:wght@300;400;500;700&family=Noto+Serif+TC:wght@400;500;600;700&display=swap');","fontFamily: { serif: ['Noto Serif TC', 'serif'], sans: ['Noto Sans TC', 'sans-serif'] }","Traditional Chinese character support. Elegant pairing."
|
||||||
|
25,Chinese Simplified,"Sans + Sans",Noto Sans SC,Noto Sans SC,"chinese, simplified, modern, professional, multilingual, readable","Simplified Chinese sites, mainland China market, business apps","https://fonts.google.com/share?selection.family=Noto+Sans+SC:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+SC:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Noto Sans SC', 'sans-serif'] }","Simplified Chinese support. Clean modern look."
|
||||||
|
26,Arabic Elegant,"Serif + Sans",Noto Naskh Arabic,Noto Sans Arabic,"arabic, elegant, traditional, cultural, RTL, readable","Arabic sites, Middle East market, Islamic content, bilingual sites","https://fonts.google.com/share?selection.family=Noto+Naskh+Arabic:wght@400;500;600;700|Noto+Sans+Arabic:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Naskh+Arabic:wght@400;500;600;700&family=Noto+Sans+Arabic:wght@300;400;500;700&display=swap');","fontFamily: { serif: ['Noto Naskh Arabic', 'serif'], sans: ['Noto Sans Arabic', 'sans-serif'] }","RTL support. Naskh for traditional, Sans for modern Arabic."
|
||||||
|
27,Thai Modern,"Sans + Sans",Noto Sans Thai,Noto Sans Thai,"thai, modern, readable, clean, multilingual, accessible","Thai sites, Southeast Asia, tourism, Thai restaurants","https://fonts.google.com/share?selection.family=Noto+Sans+Thai:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+Thai:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Noto Sans Thai', 'sans-serif'] }","Clean Thai typography. Excellent readability."
|
||||||
|
28,Hebrew Modern,"Sans + Sans",Noto Sans Hebrew,Noto Sans Hebrew,"hebrew, modern, RTL, clean, professional, readable","Hebrew sites, Israeli market, Jewish content, bilingual sites","https://fonts.google.com/share?selection.family=Noto+Sans+Hebrew:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+Hebrew:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Noto Sans Hebrew', 'sans-serif'] }","RTL support. Clean modern Hebrew typography."
|
||||||
|
29,Legal Professional,"Serif + Sans",EB Garamond,Lato,"legal, professional, traditional, trustworthy, formal, authoritative","Law firms, legal services, contracts, formal documents, government","https://fonts.google.com/share?selection.family=EB+Garamond:wght@400;500;600;700|Lato:wght@300;400;700","@import url('https://fonts.googleapis.com/css2?family=EB+Garamond:wght@400;500;600;700&family=Lato:wght@300;400;700&display=swap');","fontFamily: { serif: ['EB Garamond', 'serif'], sans: ['Lato', 'sans-serif'] }","EB Garamond for authority. Lato for clean body text."
|
||||||
|
30,Medical Clean,"Sans + Sans",Figtree,Noto Sans,"medical, clean, accessible, professional, healthcare, trustworthy","Healthcare, medical clinics, pharma, health apps, accessibility","https://fonts.google.com/share?selection.family=Figtree:wght@300;400;500;600;700|Noto+Sans:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Figtree:wght@300;400;500;600;700&family=Noto+Sans:wght@300;400;500;700&display=swap');","fontFamily: { heading: ['Figtree', 'sans-serif'], body: ['Noto Sans', 'sans-serif'] }","Clean, accessible fonts for medical contexts."
|
||||||
|
31,Financial Trust,"Sans + Sans",IBM Plex Sans,IBM Plex Sans,"financial, trustworthy, professional, corporate, banking, serious","Banks, finance, insurance, investment, fintech, enterprise","https://fonts.google.com/share?selection.family=IBM+Plex+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { sans: ['IBM Plex Sans', 'sans-serif'] }","IBM Plex conveys trust and professionalism. Excellent for data."
|
||||||
|
32,Real Estate Luxury,"Serif + Sans",Cinzel,Josefin Sans,"real estate, luxury, elegant, sophisticated, property, premium","Real estate, luxury properties, architecture, interior design","https://fonts.google.com/share?selection.family=Cinzel:wght@400;500;600;700|Josefin+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Cinzel:wght@400;500;600;700&family=Josefin+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Cinzel', 'serif'], sans: ['Josefin Sans', 'sans-serif'] }","Cinzel's elegance for headlines. Josefin for modern body."
|
||||||
|
33,Restaurant Menu,"Serif + Sans",Playfair Display SC,Karla,"restaurant, menu, culinary, elegant, foodie, hospitality","Restaurants, cafes, food blogs, culinary, hospitality","https://fonts.google.com/share?selection.family=Karla:wght@300;400;500;600;700|Playfair+Display+SC:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Karla:wght@300;400;500;600;700&family=Playfair+Display+SC:wght@400;700&display=swap');","fontFamily: { display: ['Playfair Display SC', 'serif'], sans: ['Karla', 'sans-serif'] }","Small caps Playfair for menu headers. Karla for descriptions."
|
||||||
|
34,Art Deco,"Display + Sans",Poiret One,Didact Gothic,"art deco, vintage, 1920s, elegant, decorative, gatsby","Vintage events, art deco themes, luxury hotels, classic cocktails","https://fonts.google.com/share?selection.family=Didact+Gothic|Poiret+One","@import url('https://fonts.googleapis.com/css2?family=Didact+Gothic&family=Poiret+One&display=swap');","fontFamily: { display: ['Poiret One', 'sans-serif'], sans: ['Didact Gothic', 'sans-serif'] }","Poiret One for art deco headlines only. Didact for body."
|
||||||
|
35,Magazine Style,"Serif + Sans",Libre Bodoni,Public Sans,"magazine, editorial, publishing, refined, journalism, print","Magazines, online publications, editorial content, journalism","https://fonts.google.com/share?selection.family=Libre+Bodoni:wght@400;500;600;700|Public+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Libre+Bodoni:wght@400;500;600;700&family=Public+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Libre Bodoni', 'serif'], sans: ['Public Sans', 'sans-serif'] }","Bodoni's editorial elegance. Public Sans for clean UI."
|
||||||
|
36,Crypto/Web3,"Sans + Sans",Orbitron,Exo 2,"crypto, web3, futuristic, tech, blockchain, digital","Crypto platforms, NFT, blockchain, web3, futuristic tech","https://fonts.google.com/share?selection.family=Exo+2:wght@300;400;500;600;700|Orbitron:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Exo+2:wght@300;400;500;600;700&family=Orbitron:wght@400;500;600;700&display=swap');","fontFamily: { display: ['Orbitron', 'sans-serif'], body: ['Exo 2', 'sans-serif'] }","Orbitron for futuristic headers. Exo 2 for readable body."
|
||||||
|
37,Gaming Bold,"Display + Sans",Russo One,Chakra Petch,"gaming, bold, action, esports, competitive, energetic","Gaming, esports, action games, competitive sports, entertainment","https://fonts.google.com/share?selection.family=Chakra+Petch:wght@300;400;500;600;700|Russo+One","@import url('https://fonts.googleapis.com/css2?family=Chakra+Petch:wght@300;400;500;600;700&family=Russo+One&display=swap');","fontFamily: { display: ['Russo One', 'sans-serif'], body: ['Chakra Petch', 'sans-serif'] }","Russo One for impact. Chakra Petch for techy body text."
|
||||||
|
38,Indie/Craft,"Display + Sans",Amatic SC,Cabin,"indie, craft, handmade, artisan, organic, creative","Craft brands, indie products, artisan, handmade, organic products","https://fonts.google.com/share?selection.family=Amatic+SC:wght@400;700|Cabin:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Amatic+SC:wght@400;700&family=Cabin:wght@400;500;600;700&display=swap');","fontFamily: { display: ['Amatic SC', 'sans-serif'], sans: ['Cabin', 'sans-serif'] }","Amatic for handwritten feel. Cabin for readable body."
|
||||||
|
39,Startup Bold,"Sans + Sans",Clash Display,Satoshi,"startup, bold, modern, innovative, confident, dynamic","Startups, pitch decks, product launches, bold brands","https://fonts.google.com/share?selection.family=Outfit:wght@400;500;600;700|Rubik:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Outfit:wght@400;500;600;700&family=Rubik:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Outfit', 'sans-serif'], body: ['Rubik', 'sans-serif'] }","Note: Clash Display on Fontshare. Outfit as Google alternative."
|
||||||
|
40,E-commerce Clean,"Sans + Sans",Rubik,Nunito Sans,"ecommerce, clean, shopping, product, retail, conversion","E-commerce, online stores, product pages, retail, shopping","https://fonts.google.com/share?selection.family=Nunito+Sans:wght@300;400;500;600;700|Rubik:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Nunito+Sans:wght@300;400;500;600;700&family=Rubik:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Rubik', 'sans-serif'], body: ['Nunito Sans', 'sans-serif'] }","Clean readable fonts perfect for product descriptions."
|
||||||
|
41,Academic/Research,"Serif + Sans",Crimson Pro,Atkinson Hyperlegible,"academic, research, scholarly, accessible, readable, educational","Universities, research papers, academic journals, educational","https://fonts.google.com/share?selection.family=Atkinson+Hyperlegible:wght@400;700|Crimson+Pro:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Atkinson+Hyperlegible:wght@400;700&family=Crimson+Pro:wght@400;500;600;700&display=swap');","fontFamily: { serif: ['Crimson Pro', 'serif'], sans: ['Atkinson Hyperlegible', 'sans-serif'] }","Crimson for scholarly headlines. Atkinson for accessibility."
|
||||||
|
42,Dashboard Data,"Mono + Sans",Fira Code,Fira Sans,"dashboard, data, analytics, code, technical, precise","Dashboards, analytics, data visualization, admin panels","https://fonts.google.com/share?selection.family=Fira+Code:wght@400;500;600;700|Fira+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;500;600;700&family=Fira+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { mono: ['Fira Code', 'monospace'], sans: ['Fira Sans', 'sans-serif'] }","Fira family cohesion. Code for data, Sans for labels."
|
||||||
|
43,Music/Entertainment,"Display + Sans",Righteous,Poppins,"music, entertainment, fun, energetic, bold, performance","Music platforms, entertainment, events, festivals, performers","https://fonts.google.com/share?selection.family=Poppins:wght@300;400;500;600;700|Righteous","@import url('https://fonts.googleapis.com/css2?family=Poppins:wght@300;400;500;600;700&family=Righteous&display=swap');","fontFamily: { display: ['Righteous', 'sans-serif'], sans: ['Poppins', 'sans-serif'] }","Righteous for bold entertainment headers. Poppins for body."
|
||||||
|
44,Minimalist Portfolio,"Sans + Sans",Archivo,Space Grotesk,"minimal, portfolio, designer, creative, clean, artistic","Design portfolios, creative professionals, minimalist brands","https://fonts.google.com/share?selection.family=Archivo:wght@300;400;500;600;700|Space+Grotesk:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Archivo:wght@300;400;500;600;700&family=Space+Grotesk:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Space Grotesk', 'sans-serif'], body: ['Archivo', 'sans-serif'] }","Space Grotesk for distinctive headers. Archivo for clean body."
|
||||||
|
45,Kids/Education,"Display + Sans",Baloo 2,Comic Neue,"kids, education, playful, friendly, colorful, learning","Children's apps, educational games, kid-friendly content","https://fonts.google.com/share?selection.family=Baloo+2:wght@400;500;600;700|Comic+Neue:wght@300;400;700","@import url('https://fonts.googleapis.com/css2?family=Baloo+2:wght@400;500;600;700&family=Comic+Neue:wght@300;400;700&display=swap');","fontFamily: { display: ['Baloo 2', 'sans-serif'], sans: ['Comic Neue', 'sans-serif'] }","Fun, playful fonts for children. Comic Neue is readable comic style."
|
||||||
|
46,Wedding/Romance,"Script + Serif",Great Vibes,Cormorant Infant,"wedding, romance, elegant, script, invitation, feminine","Wedding sites, invitations, romantic brands, bridal","https://fonts.google.com/share?selection.family=Cormorant+Infant:wght@300;400;500;600;700|Great+Vibes","@import url('https://fonts.googleapis.com/css2?family=Cormorant+Infant:wght@300;400;500;600;700&family=Great+Vibes&display=swap');","fontFamily: { script: ['Great Vibes', 'cursive'], serif: ['Cormorant Infant', 'serif'] }","Great Vibes for elegant accents. Cormorant for readable text."
|
||||||
|
47,Science/Tech,"Sans + Sans",Exo,Roboto Mono,"science, technology, research, data, futuristic, precise","Science, research, tech documentation, data-heavy sites","https://fonts.google.com/share?selection.family=Exo:wght@300;400;500;600;700|Roboto+Mono:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Exo:wght@300;400;500;600;700&family=Roboto+Mono:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Exo', 'sans-serif'], mono: ['Roboto Mono', 'monospace'] }","Exo for modern tech feel. Roboto Mono for code/data."
|
||||||
|
48,Accessibility First,"Sans + Sans",Atkinson Hyperlegible,Atkinson Hyperlegible,"accessible, readable, inclusive, WCAG, dyslexia-friendly, clear","Accessibility-critical sites, government, healthcare, inclusive design","https://fonts.google.com/share?selection.family=Atkinson+Hyperlegible:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Atkinson+Hyperlegible:wght@400;700&display=swap');","fontFamily: { sans: ['Atkinson Hyperlegible', 'sans-serif'] }","Designed for maximum legibility. Excellent for accessibility."
|
||||||
|
49,Sports/Fitness,"Sans + Sans",Barlow Condensed,Barlow,"sports, fitness, athletic, energetic, condensed, action","Sports, fitness, gyms, athletic brands, competition","https://fonts.google.com/share?selection.family=Barlow+Condensed:wght@400;500;600;700|Barlow:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Barlow+Condensed:wght@400;500;600;700&family=Barlow:wght@300;400;500;600;700&display=swap');","fontFamily: { display: ['Barlow Condensed', 'sans-serif'], body: ['Barlow', 'sans-serif'] }","Condensed for impact headlines. Regular Barlow for body."
|
||||||
|
50,Luxury Minimalist,"Serif + Sans",Bodoni Moda,Jost,"luxury, minimalist, high-end, sophisticated, refined, premium","Luxury minimalist brands, high-end fashion, premium products","https://fonts.google.com/share?selection.family=Bodoni+Moda:wght@400;500;600;700|Jost:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Bodoni+Moda:wght@400;500;600;700&family=Jost:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Bodoni Moda', 'serif'], sans: ['Jost', 'sans-serif'] }","Bodoni's high contrast elegance. Jost for geometric body."
|
||||||
|
51,Tech/HUD Mono,"Mono + Mono",Share Tech Mono,Fira Code,"tech, futuristic, hud, sci-fi, data, monospaced, precise","Sci-fi interfaces, developer tools, cybersecurity, dashboards","https://fonts.google.com/share?selection.family=Fira+Code:wght@300;400;500;600;700|Share+Tech+Mono","@import url('https://fonts.googleapis.com/css2?family=Fira+Code:wght@300;400;500;600;700&family=Share+Tech+Mono&display=swap');","fontFamily: { hud: ['Share Tech Mono', 'monospace'], code: ['Fira Code', 'monospace'] }","Share Tech Mono has that classic sci-fi look."
|
||||||
|
52,Pixel Retro,"Display + Sans",Press Start 2P,VT323,"pixel, retro, gaming, 8-bit, nostalgic, arcade","Pixel art games, retro websites, creative portfolios","https://fonts.google.com/share?selection.family=Press+Start+2P|VT323","@import url('https://fonts.googleapis.com/css2?family=Press+Start+2P&family=VT323&display=swap');","fontFamily: { pixel: ['Press Start 2P', 'cursive'], terminal: ['VT323', 'monospace'] }","Press Start 2P is very wide/large. VT323 is better for body text."
|
||||||
|
53,Neubrutalist Bold,"Display + Sans",Lexend Mega,Public Sans,"bold, neubrutalist, loud, strong, geometric, quirky","Neubrutalist designs, Gen Z brands, bold marketing","https://fonts.google.com/share?selection.family=Lexend+Mega:wght@100..900|Public+Sans:wght@100..900","@import url('https://fonts.googleapis.com/css2?family=Lexend+Mega:wght@100..900&family=Public+Sans:wght@100..900&display=swap');","fontFamily: { mega: ['Lexend Mega', 'sans-serif'], body: ['Public Sans', 'sans-serif'] }","Lexend Mega has distinct character and variable weight."
|
||||||
|
54,Academic/Archival,"Serif + Serif",EB Garamond,Crimson Text,"academic, old-school, university, research, serious, traditional","University sites, archives, research papers, history","https://fonts.google.com/share?selection.family=Crimson+Text:wght@400;600;700|EB+Garamond:wght@400;500;600;700;800","@import url('https://fonts.googleapis.com/css2?family=Crimson+Text:wght@400;600;700&family=EB+Garamond:wght@400;500;600;700;800&display=swap');","fontFamily: { classic: ['EB Garamond', 'serif'], text: ['Crimson Text', 'serif'] }","Classic academic aesthetic. Very legible."
|
||||||
|
55,Spatial Clear,"Sans + Sans",Inter,Inter,"spatial, legible, glass, system, clean, neutral","Spatial computing, AR/VR, glassmorphism interfaces","https://fonts.google.com/share?selection.family=Inter:wght@300;400;500;600","@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600&display=swap');","fontFamily: { sans: ['Inter', 'sans-serif'] }","Optimized for readability on dynamic backgrounds."
|
||||||
|
56,Kinetic Motion,"Display + Mono",Syncopate,Space Mono,"kinetic, motion, futuristic, speed, wide, tech","Music festivals, automotive, high-energy brands","https://fonts.google.com/share?selection.family=Space+Mono:wght@400;700|Syncopate:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Space+Mono:wght@400;700&family=Syncopate:wght@400;700&display=swap');","fontFamily: { display: ['Syncopate', 'sans-serif'], mono: ['Space Mono', 'monospace'] }","Syncopate's wide stance works well with motion effects."
|
||||||
|
57,Gen Z Brutal,"Display + Sans",Anton,Epilogue,"brutal, loud, shouty, meme, internet, bold","Gen Z marketing, streetwear, viral campaigns","https://fonts.google.com/share?selection.family=Anton|Epilogue:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Anton&family=Epilogue:wght@400;500;600;700&display=swap');","fontFamily: { display: ['Anton', 'sans-serif'], body: ['Epilogue', 'sans-serif'] }","Anton is impactful and condensed. Good for stickers/badges."
|
||||||
|
100
.claude/skills/ui-ux-pro-max/data/ux-guidelines.csv
Normal file
100
.claude/skills/ui-ux-pro-max/data/ux-guidelines.csv
Normal file
@ -0,0 +1,100 @@
|
|||||||
|
No,Category,Issue,Platform,Description,Do,Don't,Code Example Good,Code Example Bad,Severity
|
||||||
|
1,Navigation,Smooth Scroll,Web,Anchor links should scroll smoothly to target section,Use scroll-behavior: smooth on html element,Jump directly without transition,html { scroll-behavior: smooth; },<a href='#section'> without CSS,High
|
||||||
|
2,Navigation,Sticky Navigation,Web,Fixed nav should not obscure content,Add padding-top to body equal to nav height,Let nav overlap first section content,pt-20 (if nav is h-20),No padding compensation,Medium
|
||||||
|
3,Navigation,Active State,All,Current page/section should be visually indicated,Highlight active nav item with color/underline,No visual feedback on current location,text-primary border-b-2,All links same style,Medium
|
||||||
|
4,Navigation,Back Button,Mobile,Users expect back to work predictably,Preserve navigation history properly,Break browser/app back button behavior,history.pushState(),location.replace(),High
|
||||||
|
5,Navigation,Deep Linking,All,URLs should reflect current state for sharing,Update URL on state/view changes,Static URLs for dynamic content,Use query params or hash,Single URL for all states,Medium
|
||||||
|
6,Navigation,Breadcrumbs,Web,Show user location in site hierarchy,Use for sites with 3+ levels of depth,Use for flat single-level sites,Home > Category > Product,Only on deep nested pages,Low
|
||||||
|
7,Animation,Excessive Motion,All,Too many animations cause distraction and motion sickness,Animate 1-2 key elements per view maximum,Animate everything that moves,Single hero animation,animate-bounce on 5+ elements,High
|
||||||
|
8,Animation,Duration Timing,All,Animations should feel responsive not sluggish,Use 150-300ms for micro-interactions,Use animations longer than 500ms for UI,transition-all duration-200,duration-1000,Medium
|
||||||
|
9,Animation,Reduced Motion,All,Respect user's motion preferences,Check prefers-reduced-motion media query,Ignore accessibility motion settings,@media (prefers-reduced-motion: reduce),No motion query check,High
|
||||||
|
10,Animation,Loading States,All,Show feedback during async operations,Use skeleton screens or spinners,Leave UI frozen with no feedback,animate-pulse skeleton,Blank screen while loading,High
|
||||||
|
11,Animation,Hover vs Tap,All,Hover effects don't work on touch devices,Use click/tap for primary interactions,Rely only on hover for important actions,onClick handler,onMouseEnter only,High
|
||||||
|
12,Animation,Continuous Animation,All,Infinite animations are distracting,Use for loading indicators only,Use for decorative elements,animate-spin on loader,animate-bounce on icons,Medium
|
||||||
|
13,Animation,Transform Performance,Web,Some CSS properties trigger expensive repaints,Use transform and opacity for animations,Animate width/height/top/left properties,transform: translateY(),top: 10px animation,Medium
|
||||||
|
14,Animation,Easing Functions,All,Linear motion feels robotic,Use ease-out for entering ease-in for exiting,Use linear for UI transitions,ease-out,linear,Low
|
||||||
|
15,Layout,Z-Index Management,Web,Stacking context conflicts cause hidden elements,Define z-index scale system (10 20 30 50),Use arbitrary large z-index values,z-10 z-20 z-50,z-[9999],High
|
||||||
|
16,Layout,Overflow Hidden,Web,Hidden overflow can clip important content,Test all content fits within containers,Blindly apply overflow-hidden,overflow-auto with scroll,overflow-hidden truncating content,Medium
|
||||||
|
17,Layout,Fixed Positioning,Web,Fixed elements can overlap or be inaccessible,Account for safe areas and other fixed elements,Stack multiple fixed elements carelessly,Fixed nav + fixed bottom with gap,Multiple overlapping fixed elements,Medium
|
||||||
|
18,Layout,Stacking Context,Web,New stacking contexts reset z-index,Understand what creates new stacking context,Expect z-index to work across contexts,Parent with z-index isolates children,z-index: 9999 not working,Medium
|
||||||
|
19,Layout,Content Jumping,Web,Layout shift when content loads is jarring,Reserve space for async content,Let images/content push layout around,aspect-ratio or fixed height,No dimensions on images,High
|
||||||
|
20,Layout,Viewport Units,Web,100vh can be problematic on mobile browsers,Use dvh or account for mobile browser chrome,Use 100vh for full-screen mobile layouts,min-h-dvh or min-h-screen,h-screen on mobile,Medium
|
||||||
|
21,Layout,Container Width,Web,Content too wide is hard to read,Limit max-width for text content (65-75ch),Let text span full viewport width,max-w-prose or max-w-3xl,Full width paragraphs,Medium
|
||||||
|
22,Touch,Touch Target Size,Mobile,Small buttons are hard to tap accurately,Minimum 44x44px touch targets,Tiny clickable areas,min-h-[44px] min-w-[44px],w-6 h-6 buttons,High
|
||||||
|
23,Touch,Touch Spacing,Mobile,Adjacent touch targets need adequate spacing,Minimum 8px gap between touch targets,Tightly packed clickable elements,gap-2 between buttons,gap-0 or gap-1,Medium
|
||||||
|
24,Touch,Gesture Conflicts,Mobile,Custom gestures can conflict with system,Avoid horizontal swipe on main content,Override system gestures,Vertical scroll primary,Horizontal swipe carousel only,Medium
|
||||||
|
25,Touch,Tap Delay,Mobile,300ms tap delay feels laggy,Use touch-action CSS or fastclick,Default mobile tap handling,touch-action: manipulation,No touch optimization,Medium
|
||||||
|
26,Touch,Pull to Refresh,Mobile,Accidental refresh is frustrating,Disable where not needed,Enable by default everywhere,overscroll-behavior: contain,Default overscroll,Low
|
||||||
|
27,Touch,Haptic Feedback,Mobile,Tactile feedback improves interaction feel,Use for confirmations and important actions,Overuse vibration feedback,navigator.vibrate(10),Vibrate on every tap,Low
|
||||||
|
28,Interaction,Focus States,All,Keyboard users need visible focus indicators,Use visible focus rings on interactive elements,Remove focus outline without replacement,focus:ring-2 focus:ring-blue-500,outline-none without alternative,High
|
||||||
|
29,Interaction,Hover States,Web,Visual feedback on interactive elements,Change cursor and add subtle visual change,No hover feedback on clickable elements,hover:bg-gray-100 cursor-pointer,No hover style,Medium
|
||||||
|
30,Interaction,Active States,All,Show immediate feedback on press/click,Add pressed/active state visual change,No feedback during interaction,active:scale-95,No active state,Medium
|
||||||
|
31,Interaction,Disabled States,All,Clearly indicate non-interactive elements,Reduce opacity and change cursor,Confuse disabled with normal state,opacity-50 cursor-not-allowed,Same style as enabled,Medium
|
||||||
|
32,Interaction,Loading Buttons,All,Prevent double submission during async actions,Disable button and show loading state,Allow multiple clicks during processing,disabled={loading} spinner,Button clickable while loading,High
|
||||||
|
33,Interaction,Error Feedback,All,Users need to know when something fails,Show clear error messages near problem,Silent failures with no feedback,Red border + error message,No indication of error,High
|
||||||
|
34,Interaction,Success Feedback,All,Confirm successful actions to users,Show success message or visual change,No confirmation of completed action,Toast notification or checkmark,Action completes silently,Medium
|
||||||
|
35,Interaction,Confirmation Dialogs,All,Prevent accidental destructive actions,Confirm before delete/irreversible actions,Delete without confirmation,Are you sure modal,Direct delete on click,High
|
||||||
|
36,Accessibility,Color Contrast,All,Text must be readable against background,Minimum 4.5:1 ratio for normal text,Low contrast text,#333 on white (7:1),#999 on white (2.8:1),High
|
||||||
|
37,Accessibility,Color Only,All,Don't convey information by color alone,Use icons/text in addition to color,Red/green only for error/success,Red text + error icon,Red border only for error,High
|
||||||
|
38,Accessibility,Alt Text,All,Images need text alternatives,Descriptive alt text for meaningful images,Empty or missing alt attributes,alt='Dog playing in park',alt='' for content images,High
|
||||||
|
39,Accessibility,Heading Hierarchy,Web,Screen readers use headings for navigation,Use sequential heading levels h1-h6,Skip heading levels or misuse for styling,h1 then h2 then h3,h1 then h4,Medium
|
||||||
|
40,Accessibility,ARIA Labels,All,Interactive elements need accessible names,Add aria-label for icon-only buttons,Icon buttons without labels,aria-label='Close menu',<button><Icon/></button>,High
|
||||||
|
41,Accessibility,Keyboard Navigation,Web,All functionality accessible via keyboard,Tab order matches visual order,Keyboard traps or illogical tab order,tabIndex for custom order,Unreachable elements,High
|
||||||
|
42,Accessibility,Screen Reader,All,Content should make sense when read aloud,Use semantic HTML and ARIA properly,Div soup with no semantics,<nav> <main> <article>,<div> for everything,Medium
|
||||||
|
43,Accessibility,Form Labels,All,Inputs must have associated labels,Use label with for attribute or wrap input,Placeholder-only inputs,<label for='email'>,placeholder='Email' only,High
|
||||||
|
44,Accessibility,Error Messages,All,Error messages must be announced,Use aria-live or role=alert for errors,Visual-only error indication,role='alert',Red border only,High
|
||||||
|
45,Accessibility,Skip Links,Web,Allow keyboard users to skip navigation,Provide skip to main content link,No skip link on nav-heavy pages,Skip to main content link,100 tabs to reach content,Medium
|
||||||
|
46,Performance,Image Optimization,All,Large images slow page load,Use appropriate size and format (WebP),Unoptimized full-size images,srcset with multiple sizes,4000px image for 400px display,High
|
||||||
|
47,Performance,Lazy Loading,All,Load content as needed,Lazy load below-fold images and content,Load everything upfront,loading='lazy',All images eager load,Medium
|
||||||
|
48,Performance,Code Splitting,Web,Large bundles slow initial load,Split code by route/feature,Single large bundle,dynamic import(),All code in main bundle,Medium
|
||||||
|
49,Performance,Caching,Web,Repeat visits should be fast,Set appropriate cache headers,No caching strategy,Cache-Control headers,Every request hits server,Medium
|
||||||
|
50,Performance,Font Loading,Web,Web fonts can block rendering,Use font-display swap or optional,Invisible text during font load,font-display: swap,FOIT (Flash of Invisible Text),Medium
|
||||||
|
51,Performance,Third Party Scripts,Web,External scripts can block rendering,Load non-critical scripts async/defer,Synchronous third-party scripts,async or defer attribute,<script src='...'> in head,Medium
|
||||||
|
52,Performance,Bundle Size,Web,Large JavaScript slows interaction,Monitor and minimize bundle size,Ignore bundle size growth,Bundle analyzer,No size monitoring,Medium
|
||||||
|
53,Performance,Render Blocking,Web,CSS/JS can block first paint,Inline critical CSS defer non-critical,Large blocking CSS files,Critical CSS inline,All CSS in head,Medium
|
||||||
|
54,Forms,Input Labels,All,Every input needs a visible label,Always show label above or beside input,Placeholder as only label,<label>Email</label><input>,placeholder='Email' only,High
|
||||||
|
55,Forms,Error Placement,All,Errors should appear near the problem,Show error below related input,Single error message at top of form,Error under each field,All errors at form top,Medium
|
||||||
|
56,Forms,Inline Validation,All,Validate as user types or on blur,Validate on blur for most fields,Validate only on submit,onBlur validation,Submit-only validation,Medium
|
||||||
|
57,Forms,Input Types,All,Use appropriate input types,Use email tel number url etc,Text input for everything,type='email',type='text' for email,Medium
|
||||||
|
58,Forms,Autofill Support,Web,Help browsers autofill correctly,Use autocomplete attribute properly,Block or ignore autofill,autocomplete='email',autocomplete='off' everywhere,Medium
|
||||||
|
59,Forms,Required Indicators,All,Mark required fields clearly,Use asterisk or (required) text,No indication of required fields,* required indicator,Guess which are required,Medium
|
||||||
|
60,Forms,Password Visibility,All,Let users see password while typing,Toggle to show/hide password,No visibility toggle,Show/hide password button,Password always hidden,Medium
|
||||||
|
61,Forms,Submit Feedback,All,Confirm form submission status,Show loading then success/error state,No feedback after submit,Loading -> Success message,Button click with no response,High
|
||||||
|
62,Forms,Input Affordance,All,Inputs should look interactive,Use distinct input styling,Inputs that look like plain text,Border/background on inputs,Borderless inputs,Medium
|
||||||
|
63,Forms,Mobile Keyboards,Mobile,Show appropriate keyboard for input type,Use inputmode attribute,Default keyboard for all inputs,inputmode='numeric',Text keyboard for numbers,Medium
|
||||||
|
64,Responsive,Mobile First,Web,Design for mobile then enhance for larger,Start with mobile styles then add breakpoints,Desktop-first causing mobile issues,Default mobile + md: lg: xl:,Desktop default + max-width queries,Medium
|
||||||
|
65,Responsive,Breakpoint Testing,Web,Test at all common screen sizes,Test at 320 375 414 768 1024 1440,Only test on your device,Multiple device testing,Single device development,Medium
|
||||||
|
66,Responsive,Touch Friendly,Web,Mobile layouts need touch-sized targets,Increase touch targets on mobile,Same tiny buttons on mobile,Larger buttons on mobile,Desktop-sized targets on mobile,High
|
||||||
|
67,Responsive,Readable Font Size,All,Text must be readable on all devices,Minimum 16px body text on mobile,Tiny text on mobile,text-base or larger,text-xs for body text,High
|
||||||
|
68,Responsive,Viewport Meta,Web,Set viewport for mobile devices,Use width=device-width initial-scale=1,Missing or incorrect viewport,<meta name='viewport'...>,No viewport meta tag,High
|
||||||
|
69,Responsive,Horizontal Scroll,Web,Avoid horizontal scrolling,Ensure content fits viewport width,Content wider than viewport,max-w-full overflow-x-hidden,Horizontal scrollbar on mobile,High
|
||||||
|
70,Responsive,Image Scaling,Web,Images should scale with container,Use max-width: 100% on images,Fixed width images overflow,max-w-full h-auto,width='800' fixed,Medium
|
||||||
|
71,Responsive,Table Handling,Web,Tables can overflow on mobile,Use horizontal scroll or card layout,Wide tables breaking layout,overflow-x-auto wrapper,Table overflows viewport,Medium
|
||||||
|
72,Typography,Line Height,All,Adequate line height improves readability,Use 1.5-1.75 for body text,Cramped or excessive line height,leading-relaxed (1.625),leading-none (1),Medium
|
||||||
|
73,Typography,Line Length,Web,Long lines are hard to read,Limit to 65-75 characters per line,Full-width text on large screens,max-w-prose,Full viewport width text,Medium
|
||||||
|
74,Typography,Font Size Scale,All,Consistent type hierarchy aids scanning,Use consistent modular scale,Random font sizes,Type scale (12 14 16 18 24 32),Arbitrary sizes,Medium
|
||||||
|
75,Typography,Font Loading,Web,Fonts should load without layout shift,Reserve space with fallback font,Layout shift when fonts load,font-display: swap + similar fallback,No fallback font,Medium
|
||||||
|
76,Typography,Contrast Readability,All,Body text needs good contrast,Use darker text on light backgrounds,Gray text on gray background,text-gray-900 on white,text-gray-400 on gray-100,High
|
||||||
|
77,Typography,Heading Clarity,All,Headings should stand out from body,Clear size/weight difference,Headings similar to body text,Bold + larger size,Same size as body,Medium
|
||||||
|
78,Feedback,Loading Indicators,All,Show system status during waits,Show spinner/skeleton for operations > 300ms,No feedback during loading,Skeleton or spinner,Frozen UI,High
|
||||||
|
79,Feedback,Empty States,All,Guide users when no content exists,Show helpful message and action,Blank empty screens,No items yet. Create one!,Empty white space,Medium
|
||||||
|
80,Feedback,Error Recovery,All,Help users recover from errors,Provide clear next steps,Error without recovery path,Try again button + help link,Error message only,Medium
|
||||||
|
81,Feedback,Progress Indicators,All,Show progress for multi-step processes,Step indicators or progress bar,No indication of progress,Step 2 of 4 indicator,No step information,Medium
|
||||||
|
82,Feedback,Toast Notifications,All,Transient messages for non-critical info,Auto-dismiss after 3-5 seconds,Toasts that never disappear,Auto-dismiss toast,Persistent toast,Medium
|
||||||
|
83,Feedback,Confirmation Messages,All,Confirm successful actions,Brief success message,Silent success,Saved successfully toast,No confirmation,Medium
|
||||||
|
84,Content,Truncation,All,Handle long content gracefully,Truncate with ellipsis and expand option,Overflow or broken layout,line-clamp-2 with expand,Overflow or cut off,Medium
|
||||||
|
85,Content,Date Formatting,All,Use locale-appropriate date formats,Use relative or locale-aware dates,Ambiguous date formats,2 hours ago or locale format,01/02/03,Low
|
||||||
|
86,Content,Number Formatting,All,Format large numbers for readability,Use thousand separators or abbreviations,Long unformatted numbers,"1.2K or 1,234",1234567,Low
|
||||||
|
87,Content,Placeholder Content,All,Show realistic placeholders during dev,Use realistic sample data,Lorem ipsum everywhere,Real sample content,Lorem ipsum,Low
|
||||||
|
88,Onboarding,User Freedom,All,Users should be able to skip tutorials,Provide Skip and Back buttons,Force linear unskippable tour,Skip Tutorial button,Locked overlay until finished,Medium
|
||||||
|
89,Search,Autocomplete,Web,Help users find results faster,Show predictions as user types,Require full type and enter,Debounced fetch + dropdown,No suggestions,Medium
|
||||||
|
90,Search,No Results,Web,Dead ends frustrate users,Show 'No results' with suggestions,Blank screen or '0 results',Try searching for X instead,No results found.,Medium
|
||||||
|
91,Data Entry,Bulk Actions,Web,Editing one by one is tedious,Allow multi-select and bulk edit,Single row actions only,Checkbox column + Action bar,Repeated actions per row,Low
|
||||||
|
92,AI Interaction,Disclaimer,All,Users need to know they talk to AI,Clearly label AI generated content,Present AI as human,AI Assistant label,Fake human name without label,High
|
||||||
|
93,AI Interaction,Streaming,All,Waiting for full text is slow,Stream text response token by token,Show loading spinner for 10s+,Typewriter effect,Spinner until 100% complete,Medium
|
||||||
|
94,Spatial UI,Gaze Hover,VisionOS,Elements should respond to eye tracking before pinch,Scale/highlight element on look,Static element until pinch,hoverEffect(),onTap only,High
|
||||||
|
95,Spatial UI,Depth Layering,VisionOS,UI needs Z-depth to separate content from environment,Use glass material and z-offset,Flat opaque panels blocking view,.glassBackgroundEffect(),bg-white,Medium
|
||||||
|
96,Sustainability,Auto-Play Video,Web,Video consumes massive data and energy,Click-to-play or pause when off-screen,Auto-play high-res video loops,playsInline muted preload='none',autoplay loop,Medium
|
||||||
|
97,Sustainability,Asset Weight,Web,Heavy 3D/Image assets increase carbon footprint,Compress and lazy load 3D models,Load 50MB textures,Draco compression,Raw .obj files,Medium
|
||||||
|
98,AI Interaction,Feedback Loop,All,AI needs user feedback to improve,Thumps up/down or 'Regenerate',Static output only,Feedback component,Read-only text,Low
|
||||||
|
99,Accessibility,Motion Sensitivity,All,Parallax/Scroll-jacking causes nausea,Respect prefers-reduced-motion,Force scroll effects,@media (prefers-reduced-motion),ScrollTrigger.create(),High
|
||||||
|
Binary file not shown.
238
.claude/skills/ui-ux-pro-max/scripts/core.py
Normal file
238
.claude/skills/ui-ux-pro-max/scripts/core.py
Normal file
@ -0,0 +1,238 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""
|
||||||
|
UI/UX Pro Max Core - BM25 search engine for UI/UX style guides
|
||||||
|
"""
|
||||||
|
|
||||||
|
import csv
|
||||||
|
import re
|
||||||
|
from pathlib import Path
|
||||||
|
from math import log
|
||||||
|
from collections import defaultdict
|
||||||
|
|
||||||
|
# ============ CONFIGURATION ============
|
||||||
|
DATA_DIR = Path(__file__).parent.parent / "data"
|
||||||
|
MAX_RESULTS = 3
|
||||||
|
|
||||||
|
CSV_CONFIG = {
|
||||||
|
"style": {
|
||||||
|
"file": "styles.csv",
|
||||||
|
"search_cols": ["Style Category", "Keywords", "Best For", "Type"],
|
||||||
|
"output_cols": ["Style Category", "Type", "Keywords", "Primary Colors", "Effects & Animation", "Best For", "Performance", "Accessibility", "Framework Compatibility", "Complexity"]
|
||||||
|
},
|
||||||
|
"prompt": {
|
||||||
|
"file": "prompts.csv",
|
||||||
|
"search_cols": ["Style Category", "AI Prompt Keywords (Copy-Paste Ready)", "CSS/Technical Keywords"],
|
||||||
|
"output_cols": ["Style Category", "AI Prompt Keywords (Copy-Paste Ready)", "CSS/Technical Keywords", "Implementation Checklist"]
|
||||||
|
},
|
||||||
|
"color": {
|
||||||
|
"file": "colors.csv",
|
||||||
|
"search_cols": ["Product Type", "Keywords", "Notes"],
|
||||||
|
"output_cols": ["Product Type", "Keywords", "Primary (Hex)", "Secondary (Hex)", "CTA (Hex)", "Background (Hex)", "Text (Hex)", "Border (Hex)", "Notes"]
|
||||||
|
},
|
||||||
|
"chart": {
|
||||||
|
"file": "charts.csv",
|
||||||
|
"search_cols": ["Data Type", "Keywords", "Best Chart Type", "Accessibility Notes"],
|
||||||
|
"output_cols": ["Data Type", "Keywords", "Best Chart Type", "Secondary Options", "Color Guidance", "Accessibility Notes", "Library Recommendation", "Interactive Level"]
|
||||||
|
},
|
||||||
|
"landing": {
|
||||||
|
"file": "landing.csv",
|
||||||
|
"search_cols": ["Pattern Name", "Keywords", "Conversion Optimization", "Section Order"],
|
||||||
|
"output_cols": ["Pattern Name", "Keywords", "Section Order", "Primary CTA Placement", "Color Strategy", "Conversion Optimization"]
|
||||||
|
},
|
||||||
|
"product": {
|
||||||
|
"file": "products.csv",
|
||||||
|
"search_cols": ["Product Type", "Keywords", "Primary Style Recommendation", "Key Considerations"],
|
||||||
|
"output_cols": ["Product Type", "Keywords", "Primary Style Recommendation", "Secondary Styles", "Landing Page Pattern", "Dashboard Style (if applicable)", "Color Palette Focus"]
|
||||||
|
},
|
||||||
|
"ux": {
|
||||||
|
"file": "ux-guidelines.csv",
|
||||||
|
"search_cols": ["Category", "Issue", "Description", "Platform"],
|
||||||
|
"output_cols": ["Category", "Issue", "Platform", "Description", "Do", "Don't", "Code Example Good", "Code Example Bad", "Severity"]
|
||||||
|
},
|
||||||
|
"typography": {
|
||||||
|
"file": "typography.csv",
|
||||||
|
"search_cols": ["Font Pairing Name", "Category", "Mood/Style Keywords", "Best For", "Heading Font", "Body Font"],
|
||||||
|
"output_cols": ["Font Pairing Name", "Category", "Heading Font", "Body Font", "Mood/Style Keywords", "Best For", "Google Fonts URL", "CSS Import", "Tailwind Config", "Notes"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
STACK_CONFIG = {
|
||||||
|
"html-tailwind": {"file": "stacks/html-tailwind.csv"},
|
||||||
|
"react": {"file": "stacks/react.csv"},
|
||||||
|
"nextjs": {"file": "stacks/nextjs.csv"},
|
||||||
|
"vue": {"file": "stacks/vue.csv"},
|
||||||
|
"nuxtjs": {"file": "stacks/nuxtjs.csv"},
|
||||||
|
"nuxt-ui": {"file": "stacks/nuxt-ui.csv"},
|
||||||
|
"svelte": {"file": "stacks/svelte.csv"},
|
||||||
|
"swiftui": {"file": "stacks/swiftui.csv"},
|
||||||
|
"react-native": {"file": "stacks/react-native.csv"},
|
||||||
|
"flutter": {"file": "stacks/flutter.csv"}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Common columns for all stacks
|
||||||
|
_STACK_COLS = {
|
||||||
|
"search_cols": ["Category", "Guideline", "Description", "Do", "Don't"],
|
||||||
|
"output_cols": ["Category", "Guideline", "Description", "Do", "Don't", "Code Good", "Code Bad", "Severity", "Docs URL"]
|
||||||
|
}
|
||||||
|
|
||||||
|
AVAILABLE_STACKS = list(STACK_CONFIG.keys())
|
||||||
|
|
||||||
|
|
||||||
|
# ============ BM25 IMPLEMENTATION ============
|
||||||
|
class BM25:
|
||||||
|
"""BM25 ranking algorithm for text search"""
|
||||||
|
|
||||||
|
def __init__(self, k1=1.5, b=0.75):
|
||||||
|
self.k1 = k1
|
||||||
|
self.b = b
|
||||||
|
self.corpus = []
|
||||||
|
self.doc_lengths = []
|
||||||
|
self.avgdl = 0
|
||||||
|
self.idf = {}
|
||||||
|
self.doc_freqs = defaultdict(int)
|
||||||
|
self.N = 0
|
||||||
|
|
||||||
|
def tokenize(self, text):
|
||||||
|
"""Lowercase, split, remove punctuation, filter short words"""
|
||||||
|
text = re.sub(r'[^\w\s]', ' ', str(text).lower())
|
||||||
|
return [w for w in text.split() if len(w) > 2]
|
||||||
|
|
||||||
|
def fit(self, documents):
|
||||||
|
"""Build BM25 index from documents"""
|
||||||
|
self.corpus = [self.tokenize(doc) for doc in documents]
|
||||||
|
self.N = len(self.corpus)
|
||||||
|
if self.N == 0:
|
||||||
|
return
|
||||||
|
self.doc_lengths = [len(doc) for doc in self.corpus]
|
||||||
|
self.avgdl = sum(self.doc_lengths) / self.N
|
||||||
|
|
||||||
|
for doc in self.corpus:
|
||||||
|
seen = set()
|
||||||
|
for word in doc:
|
||||||
|
if word not in seen:
|
||||||
|
self.doc_freqs[word] += 1
|
||||||
|
seen.add(word)
|
||||||
|
|
||||||
|
for word, freq in self.doc_freqs.items():
|
||||||
|
self.idf[word] = log((self.N - freq + 0.5) / (freq + 0.5) + 1)
|
||||||
|
|
||||||
|
def score(self, query):
|
||||||
|
"""Score all documents against query"""
|
||||||
|
query_tokens = self.tokenize(query)
|
||||||
|
scores = []
|
||||||
|
|
||||||
|
for idx, doc in enumerate(self.corpus):
|
||||||
|
score = 0
|
||||||
|
doc_len = self.doc_lengths[idx]
|
||||||
|
term_freqs = defaultdict(int)
|
||||||
|
for word in doc:
|
||||||
|
term_freqs[word] += 1
|
||||||
|
|
||||||
|
for token in query_tokens:
|
||||||
|
if token in self.idf:
|
||||||
|
tf = term_freqs[token]
|
||||||
|
idf = self.idf[token]
|
||||||
|
numerator = tf * (self.k1 + 1)
|
||||||
|
denominator = tf + self.k1 * (1 - self.b + self.b * doc_len / self.avgdl)
|
||||||
|
score += idf * numerator / denominator
|
||||||
|
|
||||||
|
scores.append((idx, score))
|
||||||
|
|
||||||
|
return sorted(scores, key=lambda x: x[1], reverse=True)
|
||||||
|
|
||||||
|
|
||||||
|
# ============ SEARCH FUNCTIONS ============
|
||||||
|
def _load_csv(filepath):
|
||||||
|
"""Load CSV and return list of dicts"""
|
||||||
|
with open(filepath, 'r', encoding='utf-8') as f:
|
||||||
|
return list(csv.DictReader(f))
|
||||||
|
|
||||||
|
|
||||||
|
def _search_csv(filepath, search_cols, output_cols, query, max_results):
|
||||||
|
"""Core search function using BM25"""
|
||||||
|
if not filepath.exists():
|
||||||
|
return []
|
||||||
|
|
||||||
|
data = _load_csv(filepath)
|
||||||
|
|
||||||
|
# Build documents from search columns
|
||||||
|
documents = [" ".join(str(row.get(col, "")) for col in search_cols) for row in data]
|
||||||
|
|
||||||
|
# BM25 search
|
||||||
|
bm25 = BM25()
|
||||||
|
bm25.fit(documents)
|
||||||
|
ranked = bm25.score(query)
|
||||||
|
|
||||||
|
# Get top results with score > 0
|
||||||
|
results = []
|
||||||
|
for idx, score in ranked[:max_results]:
|
||||||
|
if score > 0:
|
||||||
|
row = data[idx]
|
||||||
|
results.append({col: row.get(col, "") for col in output_cols if col in row})
|
||||||
|
|
||||||
|
return results
|
||||||
|
|
||||||
|
|
||||||
|
def detect_domain(query):
|
||||||
|
"""Auto-detect the most relevant domain from query"""
|
||||||
|
query_lower = query.lower()
|
||||||
|
|
||||||
|
domain_keywords = {
|
||||||
|
"color": ["color", "palette", "hex", "#", "rgb"],
|
||||||
|
"chart": ["chart", "graph", "visualization", "trend", "bar", "pie", "scatter", "heatmap", "funnel"],
|
||||||
|
"landing": ["landing", "page", "cta", "conversion", "hero", "testimonial", "pricing", "section"],
|
||||||
|
"product": ["saas", "ecommerce", "e-commerce", "fintech", "healthcare", "gaming", "portfolio", "crypto", "dashboard"],
|
||||||
|
"prompt": ["prompt", "css", "implementation", "variable", "checklist", "tailwind"],
|
||||||
|
"style": ["style", "design", "ui", "minimalism", "glassmorphism", "neumorphism", "brutalism", "dark mode", "flat", "aurora"],
|
||||||
|
"ux": ["ux", "usability", "accessibility", "wcag", "touch", "scroll", "animation", "keyboard", "navigation", "mobile"],
|
||||||
|
"typography": ["font", "typography", "heading", "serif", "sans"]
|
||||||
|
}
|
||||||
|
|
||||||
|
scores = {domain: sum(1 for kw in keywords if kw in query_lower) for domain, keywords in domain_keywords.items()}
|
||||||
|
best = max(scores, key=scores.get)
|
||||||
|
return best if scores[best] > 0 else "style"
|
||||||
|
|
||||||
|
|
||||||
|
def search(query, domain=None, max_results=MAX_RESULTS):
|
||||||
|
"""Main search function with auto-domain detection"""
|
||||||
|
if domain is None:
|
||||||
|
domain = detect_domain(query)
|
||||||
|
|
||||||
|
config = CSV_CONFIG.get(domain, CSV_CONFIG["style"])
|
||||||
|
filepath = DATA_DIR / config["file"]
|
||||||
|
|
||||||
|
if not filepath.exists():
|
||||||
|
return {"error": f"File not found: {filepath}", "domain": domain}
|
||||||
|
|
||||||
|
results = _search_csv(filepath, config["search_cols"], config["output_cols"], query, max_results)
|
||||||
|
|
||||||
|
return {
|
||||||
|
"domain": domain,
|
||||||
|
"query": query,
|
||||||
|
"file": config["file"],
|
||||||
|
"count": len(results),
|
||||||
|
"results": results
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def search_stack(query, stack, max_results=MAX_RESULTS):
|
||||||
|
"""Search stack-specific guidelines"""
|
||||||
|
if stack not in STACK_CONFIG:
|
||||||
|
return {"error": f"Unknown stack: {stack}. Available: {', '.join(AVAILABLE_STACKS)}"}
|
||||||
|
|
||||||
|
filepath = DATA_DIR / STACK_CONFIG[stack]["file"]
|
||||||
|
|
||||||
|
if not filepath.exists():
|
||||||
|
return {"error": f"Stack file not found: {filepath}", "stack": stack}
|
||||||
|
|
||||||
|
results = _search_csv(filepath, _STACK_COLS["search_cols"], _STACK_COLS["output_cols"], query, max_results)
|
||||||
|
|
||||||
|
return {
|
||||||
|
"domain": "stack",
|
||||||
|
"stack": stack,
|
||||||
|
"query": query,
|
||||||
|
"file": STACK_CONFIG[stack]["file"],
|
||||||
|
"count": len(results),
|
||||||
|
"results": results
|
||||||
|
}
|
||||||
61
.claude/skills/ui-ux-pro-max/scripts/search.py
Normal file
61
.claude/skills/ui-ux-pro-max/scripts/search.py
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""
|
||||||
|
UI/UX Pro Max Search - BM25 search engine for UI/UX style guides
|
||||||
|
Usage: python search.py "<query>" [--domain <domain>] [--stack <stack>] [--max-results 3]
|
||||||
|
|
||||||
|
Domains: style, prompt, color, chart, landing, product, ux, typography
|
||||||
|
Stacks: html-tailwind, react, nextjs
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
from core import CSV_CONFIG, AVAILABLE_STACKS, MAX_RESULTS, search, search_stack
|
||||||
|
|
||||||
|
|
||||||
|
def format_output(result):
|
||||||
|
"""Format results for Claude consumption (token-optimized)"""
|
||||||
|
if "error" in result:
|
||||||
|
return f"Error: {result['error']}"
|
||||||
|
|
||||||
|
output = []
|
||||||
|
if result.get("stack"):
|
||||||
|
output.append(f"## UI Pro Max Stack Guidelines")
|
||||||
|
output.append(f"**Stack:** {result['stack']} | **Query:** {result['query']}")
|
||||||
|
else:
|
||||||
|
output.append(f"## UI Pro Max Search Results")
|
||||||
|
output.append(f"**Domain:** {result['domain']} | **Query:** {result['query']}")
|
||||||
|
output.append(f"**Source:** {result['file']} | **Found:** {result['count']} results\n")
|
||||||
|
|
||||||
|
for i, row in enumerate(result['results'], 1):
|
||||||
|
output.append(f"### Result {i}")
|
||||||
|
for key, value in row.items():
|
||||||
|
value_str = str(value)
|
||||||
|
if len(value_str) > 300:
|
||||||
|
value_str = value_str[:300] + "..."
|
||||||
|
output.append(f"- **{key}:** {value_str}")
|
||||||
|
output.append("")
|
||||||
|
|
||||||
|
return "\n".join(output)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
parser = argparse.ArgumentParser(description="UI Pro Max Search")
|
||||||
|
parser.add_argument("query", help="Search query")
|
||||||
|
parser.add_argument("--domain", "-d", choices=list(CSV_CONFIG.keys()), help="Search domain")
|
||||||
|
parser.add_argument("--stack", "-s", choices=AVAILABLE_STACKS, help="Stack-specific search (html-tailwind, react, nextjs)")
|
||||||
|
parser.add_argument("--max-results", "-n", type=int, default=MAX_RESULTS, help="Max results (default: 3)")
|
||||||
|
parser.add_argument("--json", action="store_true", help="Output as JSON")
|
||||||
|
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
# Stack search takes priority
|
||||||
|
if args.stack:
|
||||||
|
result = search_stack(args.query, args.stack, args.max_results)
|
||||||
|
else:
|
||||||
|
result = search(args.query, args.domain, args.max_results)
|
||||||
|
|
||||||
|
if args.json:
|
||||||
|
import json
|
||||||
|
print(json.dumps(result, indent=2, ensure_ascii=False))
|
||||||
|
else:
|
||||||
|
print(format_output(result))
|
||||||
607
.claude/ui-design-system.md
Normal file
607
.claude/ui-design-system.md
Normal file
@ -0,0 +1,607 @@
|
|||||||
|
# 比赛管理系统 - UI设计系统文档
|
||||||
|
|
||||||
|
> 版本: 1.0
|
||||||
|
> 更新日期: 2026-01-14
|
||||||
|
> 框架: Vue 3 + Ant Design Vue + Tailwind CSS
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📋 目录
|
||||||
|
|
||||||
|
1. [设计理念](#设计理念)
|
||||||
|
2. [色彩系统](#色彩系统)
|
||||||
|
3. [布局规范](#布局规范)
|
||||||
|
4. [组件规范](#组件规范)
|
||||||
|
5. [双主题架构](#双主题架构)
|
||||||
|
6. [风格统一建议](#风格统一建议)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎨 设计理念
|
||||||
|
|
||||||
|
### 整体定位
|
||||||
|
- **企业级应用**: 专业、可靠、易用
|
||||||
|
- **教育科技**: 现代、创新、智能
|
||||||
|
- **双主题并存**: 传统业务管理 + 创新AI功能
|
||||||
|
|
||||||
|
### 设计原则
|
||||||
|
1. **一致性优先**: 相同功能使用相同的交互模式
|
||||||
|
2. **效率至上**: 减少用户操作步骤,提升工作效率
|
||||||
|
3. **清晰明确**: 信息层级分明,状态反馈清晰
|
||||||
|
4. **渐进增强**: 基础功能稳定,高级功能突出
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎨 色彩系统
|
||||||
|
|
||||||
|
### 主题A:标准业务主题(用于普通页面)
|
||||||
|
|
||||||
|
#### 主色调 - 蓝色系
|
||||||
|
```scss
|
||||||
|
--ant-color-primary: #0958d9 // 主色(Ant Design blue-6)
|
||||||
|
--ant-color-primary-hover: #1677ff // 悬停色(blue-5)
|
||||||
|
--ant-color-primary-active: #003eb3 // 激活色(blue-7)
|
||||||
|
--ant-color-primary-bg: #e6f7ff // 主色背景(blue-0)
|
||||||
|
--ant-color-primary-bg-hover: #bae7ff // 主色背景悬停(blue-1)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 功能色
|
||||||
|
```scss
|
||||||
|
--ant-color-success: #52c41a // 成功(绿色)
|
||||||
|
--ant-color-error: #ff4d4f // 错误(红色)
|
||||||
|
--ant-color-warning: #faad14 // 警告(黄色)
|
||||||
|
--ant-color-info: #0958d9 // 信息(蓝色)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 中性色
|
||||||
|
```scss
|
||||||
|
// 文字
|
||||||
|
--ant-color-text: rgba(0, 0, 0, 0.85) // 主文字
|
||||||
|
--ant-color-text-secondary: rgba(0, 0, 0, 0.45) // 次要文字
|
||||||
|
--ant-color-text-tertiary: rgba(0, 0, 0, 0.25) // 辅助文字
|
||||||
|
|
||||||
|
// 边框
|
||||||
|
--ant-color-border: #d9d9d9 // 主边框
|
||||||
|
--ant-color-border-secondary: rgba(0, 0, 0, 0.06) // 次边框
|
||||||
|
|
||||||
|
// 背景
|
||||||
|
--ant-color-bg-container: #ffffff // 容器背景
|
||||||
|
--ant-color-bg-layout: #f5f5f5 // 布局背景
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 侧边栏主题
|
||||||
|
```scss
|
||||||
|
--sidebar-bg: #f5f5f5 // 侧边栏背景
|
||||||
|
--sidebar-menu-item-hover: #e6f7ff // 菜单项悬停
|
||||||
|
--sidebar-menu-item-selected-bg: #e6f7ff // 菜单项选中背景
|
||||||
|
--sidebar-menu-text: rgba(0, 0, 0, 0.85) // 菜单文字
|
||||||
|
--sidebar-menu-text-selected: #0958d9 // 选中文字
|
||||||
|
```
|
||||||
|
|
||||||
|
### 主题B:现代创意主题(用于3D建模页面)
|
||||||
|
|
||||||
|
#### 主色调 - 深色科技风
|
||||||
|
```scss
|
||||||
|
$primary: #7c3aed // 深紫色
|
||||||
|
$primary-light: #a78bfa // 浅紫色
|
||||||
|
$primary-dark: #5b21b6 // 深紫暗色
|
||||||
|
$secondary: #06b6d4 // 青蓝色
|
||||||
|
$accent: #f43f5e // 粉红强调色
|
||||||
|
$success: #10b981 // 成功绿
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 背景与表面
|
||||||
|
```scss
|
||||||
|
$background: #0a0a12 // 主背景(深黑)
|
||||||
|
$surface: #12121e // 卡片表面(深灰)
|
||||||
|
$surface-light: #1a1a2e // 浅表面
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 文字色
|
||||||
|
```scss
|
||||||
|
$text: #e2e8f0 // 主文字(浅灰)
|
||||||
|
$text-muted: #94a3b8 // 次要文字
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 渐变
|
||||||
|
```scss
|
||||||
|
$gradient-primary: linear-gradient(135deg, #7c3aed 0%, #ec4899 100%)
|
||||||
|
$gradient-secondary: linear-gradient(135deg, #06b6d4 0%, #7c3aed 100%)
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📐 布局规范
|
||||||
|
|
||||||
|
### 间距系统(8px基础单位)
|
||||||
|
|
||||||
|
```scss
|
||||||
|
$spacing-xs: 8px // 超小间距
|
||||||
|
$spacing-sm: 16px // 小间距
|
||||||
|
$spacing-md: 24px // 中间距
|
||||||
|
$spacing-lg: 32px // 大间距
|
||||||
|
$spacing-xl: 48px // 超大间距
|
||||||
|
```
|
||||||
|
|
||||||
|
### 标准布局
|
||||||
|
|
||||||
|
#### 侧边栏布局(BasicLayout)
|
||||||
|
```
|
||||||
|
- 侧边栏宽度: 200px
|
||||||
|
- 侧边栏背景: #f5f5f5
|
||||||
|
- Logo高度: 64px
|
||||||
|
- 菜单项外边距: 4px 8px
|
||||||
|
- 菜单项圆角: 6px
|
||||||
|
- 内容区内边距: 20px
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 卡片间距
|
||||||
|
```scss
|
||||||
|
.card {
|
||||||
|
padding: 16px;
|
||||||
|
border-radius: 8px;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
background: #fff;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 搜索表单
|
||||||
|
```scss
|
||||||
|
.search-form {
|
||||||
|
padding: 16px;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
border-radius: 8px;
|
||||||
|
background: #fafafa;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 栅格系统
|
||||||
|
- 使用Ant Design 24栅格系统
|
||||||
|
- 常用布局: `<a-col :span="24" :md="12" :lg="8">`
|
||||||
|
- 响应式断点: xs(480), sm(576), md(768), lg(992), xl(1200), xxl(1600)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧩 组件规范
|
||||||
|
|
||||||
|
### 按钮
|
||||||
|
|
||||||
|
#### 类型与用途
|
||||||
|
```vue
|
||||||
|
<!-- 主要操作 -->
|
||||||
|
<a-button type="primary">创建</a-button>
|
||||||
|
|
||||||
|
<!-- 次要操作 -->
|
||||||
|
<a-button>取消</a-button>
|
||||||
|
|
||||||
|
<!-- 文字按钮 -->
|
||||||
|
<a-button type="link">查看详情</a-button>
|
||||||
|
|
||||||
|
<!-- 危险操作 -->
|
||||||
|
<a-button danger>删除</a-button>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 尺寸
|
||||||
|
```vue
|
||||||
|
<a-button size="large">大按钮</a-button>
|
||||||
|
<a-button>默认按钮</a-button>
|
||||||
|
<a-button size="small">小按钮</a-button>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 按钮组合间距
|
||||||
|
```scss
|
||||||
|
.button-group {
|
||||||
|
.ant-btn + .ant-btn {
|
||||||
|
margin-left: 8px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 表格
|
||||||
|
|
||||||
|
#### 标准配置
|
||||||
|
```typescript
|
||||||
|
{
|
||||||
|
bordered: false, // 不显示边框(默认)
|
||||||
|
size: 'middle', // 默认尺寸
|
||||||
|
pagination: {
|
||||||
|
defaultPageSize: 10, // 默认每页10条
|
||||||
|
showSizeChanger: true, // 显示切换器
|
||||||
|
showQuickJumper: true, // 显示快速跳转
|
||||||
|
showTotal: (total) => `共 ${total} 条`,
|
||||||
|
},
|
||||||
|
rowKey: 'id', // 行键
|
||||||
|
loading: false, // 加载状态
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 列宽建议
|
||||||
|
```
|
||||||
|
- ID列: 80px
|
||||||
|
- 名称列: 120-200px
|
||||||
|
- 描述列: 200-300px
|
||||||
|
- 时间列: 180px
|
||||||
|
- 状态列: 100px
|
||||||
|
- 操作列: 120-200px (fixed: 'right')
|
||||||
|
```
|
||||||
|
|
||||||
|
### 表单
|
||||||
|
|
||||||
|
#### 布局
|
||||||
|
```vue
|
||||||
|
<a-form
|
||||||
|
:model="form"
|
||||||
|
:label-col="{ span: 6 }"
|
||||||
|
:wrapper-col="{ span: 16 }"
|
||||||
|
>
|
||||||
|
<!-- 表单项 -->
|
||||||
|
</a-form>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 输入框宽度
|
||||||
|
```
|
||||||
|
- 短文本(名称、编号): 200px
|
||||||
|
- 中文本(描述): 300-400px
|
||||||
|
- 长文本(详情): 100%
|
||||||
|
- 选择框(状态、类型): 120-200px
|
||||||
|
- 日期选择: 200px
|
||||||
|
- 日期范围: 280px
|
||||||
|
```
|
||||||
|
|
||||||
|
### 标签(Tags)
|
||||||
|
|
||||||
|
#### 颜色语义
|
||||||
|
```vue
|
||||||
|
<!-- 状态标签 -->
|
||||||
|
<a-tag color="success">已发布</a-tag>
|
||||||
|
<a-tag color="processing">进行中</a-tag>
|
||||||
|
<a-tag color="default">草稿</a-tag>
|
||||||
|
<a-tag color="error">已关闭</a-tag>
|
||||||
|
|
||||||
|
<!-- 类型标签 -->
|
||||||
|
<a-tag color="blue">个人赛</a-tag>
|
||||||
|
<a-tag color="purple">团队赛</a-tag>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 模态框与抽屉
|
||||||
|
|
||||||
|
#### 模态框
|
||||||
|
```vue
|
||||||
|
<a-modal
|
||||||
|
v-model:open="visible"
|
||||||
|
title="标题"
|
||||||
|
width="600px"
|
||||||
|
@ok="handleOk"
|
||||||
|
@cancel="handleCancel"
|
||||||
|
>
|
||||||
|
<!-- 内容 -->
|
||||||
|
</a-modal>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 抽屉
|
||||||
|
```vue
|
||||||
|
<a-drawer
|
||||||
|
v-model:open="visible"
|
||||||
|
title="标题"
|
||||||
|
width="600px"
|
||||||
|
placement="right"
|
||||||
|
>
|
||||||
|
<!-- 内容 -->
|
||||||
|
</a-drawer>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 卡片
|
||||||
|
|
||||||
|
#### 标准卡片
|
||||||
|
```vue
|
||||||
|
<a-card title="标题" class="mb-4">
|
||||||
|
<!-- 内容 -->
|
||||||
|
</a-card>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 无边框卡片
|
||||||
|
```vue
|
||||||
|
<a-card :bordered="false" class="mb-4">
|
||||||
|
<!-- 内容 -->
|
||||||
|
</a-card>
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🌓 双主题架构
|
||||||
|
|
||||||
|
### 主题A:标准业务主题
|
||||||
|
|
||||||
|
**适用页面:**
|
||||||
|
- 赛事管理(contests)
|
||||||
|
- 学校管理(school)
|
||||||
|
- 作业管理(homework)
|
||||||
|
- 系统管理(system)
|
||||||
|
- 登录页面(auth)
|
||||||
|
|
||||||
|
**设计特征:**
|
||||||
|
- ✅ 浅色背景(#ffffff, #f5f5f5)
|
||||||
|
- ✅ 蓝色主题(#0958d9)
|
||||||
|
- ✅ 标准Ant Design组件样式
|
||||||
|
- ✅ 简洁的过渡动画(0.3s)
|
||||||
|
- ✅ 表格为主要数据展示方式
|
||||||
|
- ✅ 圆角: 6-8px
|
||||||
|
- ✅ 轻微阴影效果
|
||||||
|
|
||||||
|
**代码示例:**
|
||||||
|
```vue
|
||||||
|
<template>
|
||||||
|
<div class="page-container">
|
||||||
|
<!-- 搜索区 -->
|
||||||
|
<a-card class="search-card mb-4">
|
||||||
|
<a-form layout="inline">
|
||||||
|
<a-form-item label="搜索">
|
||||||
|
<a-input v-model:value="keyword" placeholder="请输入" />
|
||||||
|
</a-form-item>
|
||||||
|
<a-form-item>
|
||||||
|
<a-button type="primary">查询</a-button>
|
||||||
|
<a-button class="ml-2">重置</a-button>
|
||||||
|
</a-form-item>
|
||||||
|
</a-form>
|
||||||
|
</a-card>
|
||||||
|
|
||||||
|
<!-- 数据表格 -->
|
||||||
|
<a-card>
|
||||||
|
<a-table
|
||||||
|
:columns="columns"
|
||||||
|
:data-source="dataSource"
|
||||||
|
:loading="loading"
|
||||||
|
:pagination="pagination"
|
||||||
|
/>
|
||||||
|
</a-card>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped lang="scss">
|
||||||
|
.page-container {
|
||||||
|
padding: 20px;
|
||||||
|
background: #fff;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-card {
|
||||||
|
background: #fafafa;
|
||||||
|
border-radius: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.mb-4 {
|
||||||
|
margin-bottom: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ml-2 {
|
||||||
|
margin-left: 8px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 主题B:现代创意主题
|
||||||
|
|
||||||
|
**适用页面:**
|
||||||
|
- 3D建模实验室(workbench/ai-3d)
|
||||||
|
- AI相关创新功能
|
||||||
|
|
||||||
|
**设计特征:**
|
||||||
|
- ✅ 深色背景(#0a0a12)
|
||||||
|
- ✅ 紫色+青蓝色主题(#7c3aed, #06b6d4)
|
||||||
|
- ✅ 玻璃态效果(backdrop-filter: blur())
|
||||||
|
- ✅ 复杂动画(浮动、旋转、脉冲)
|
||||||
|
- ✅ 卡片网格布局
|
||||||
|
- ✅ 圆角: 12-20px
|
||||||
|
- ✅ 发光效果(glow)
|
||||||
|
- ✅ 渐变背景
|
||||||
|
|
||||||
|
**代码示例:**
|
||||||
|
```vue
|
||||||
|
<template>
|
||||||
|
<div class="ai-3d-container">
|
||||||
|
<!-- 动画背景 -->
|
||||||
|
<div class="bg-animation">
|
||||||
|
<div class="bg-gradient bg-gradient-1"></div>
|
||||||
|
<div class="bg-gradient bg-gradient-2"></div>
|
||||||
|
<div class="bg-grid"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- 左侧面板 -->
|
||||||
|
<div class="left-panel">
|
||||||
|
<!-- 内容 -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- 右侧内容 -->
|
||||||
|
<div class="right-panel">
|
||||||
|
<!-- 内容 -->
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped lang="scss">
|
||||||
|
$primary: #7c3aed;
|
||||||
|
$secondary: #06b6d4;
|
||||||
|
$background: #0a0a12;
|
||||||
|
|
||||||
|
.ai-3d-container {
|
||||||
|
min-height: 100vh;
|
||||||
|
background: $background;
|
||||||
|
position: relative;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.bg-animation {
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
pointer-events: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.bg-gradient {
|
||||||
|
position: absolute;
|
||||||
|
border-radius: 50%;
|
||||||
|
filter: blur(120px);
|
||||||
|
opacity: 0.4;
|
||||||
|
animation: float 25s ease-in-out infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
.left-panel {
|
||||||
|
width: 380px;
|
||||||
|
background: rgba(18, 18, 30, 0.8);
|
||||||
|
backdrop-filter: blur(40px);
|
||||||
|
border-right: 1px solid rgba($primary, 0.1);
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes float {
|
||||||
|
0%, 100% {
|
||||||
|
transform: translate(0, 0) scale(1);
|
||||||
|
}
|
||||||
|
50% {
|
||||||
|
transform: translate(-30px, 30px) scale(0.9);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔄 风格统一建议
|
||||||
|
|
||||||
|
### 问题分析
|
||||||
|
目前3D建模页面与其他业务页面风格差异较大,可能导致:
|
||||||
|
- 用户体验割裂感
|
||||||
|
- 视觉不统一
|
||||||
|
- 品牌识别度降低
|
||||||
|
|
||||||
|
### 统一方案
|
||||||
|
|
||||||
|
#### 方案A:保守统一(推荐用于企业应用)
|
||||||
|
**目标:** 将3D页面统一到标准业务主题
|
||||||
|
|
||||||
|
**调整内容:**
|
||||||
|
1. **色彩调整**
|
||||||
|
- 主色由紫色改为蓝色(#7c3aed → #0958d9)
|
||||||
|
- 背景改为浅色(#0a0a12 → #f5f5f5)
|
||||||
|
- 文字改为深色(#e2e8f0 → rgba(0,0,0,0.85))
|
||||||
|
|
||||||
|
2. **布局调整**
|
||||||
|
- 使用标准卡片布局
|
||||||
|
- 保持双面板结构,但使用浅色背景
|
||||||
|
- 移除动画背景
|
||||||
|
|
||||||
|
3. **组件调整**
|
||||||
|
- 圆角统一为8px
|
||||||
|
- 移除玻璃态效果
|
||||||
|
- 简化动画效果
|
||||||
|
|
||||||
|
4. **保留特色**
|
||||||
|
- 保留双面板布局(体现AI功能特殊性)
|
||||||
|
- 保留历史记录网格展示
|
||||||
|
- 保留进度动画反馈
|
||||||
|
|
||||||
|
**优点:** 风格统一,专业稳重
|
||||||
|
**缺点:** 失去部分科技感和创新感
|
||||||
|
|
||||||
|
#### 方案B:渐进融合(推荐用于创新型应用)
|
||||||
|
**目标:** 在保留创新感的同时,与主题色对齐
|
||||||
|
|
||||||
|
**调整内容:**
|
||||||
|
1. **色彩微调**
|
||||||
|
- 主色保持紫色,但添加蓝色辅助色
|
||||||
|
- 使用浅色变体(深蓝色背景 #0f172a 代替纯黑)
|
||||||
|
- 增加白色卡片区域(保留部分深色背景)
|
||||||
|
|
||||||
|
2. **融合元素**
|
||||||
|
- 顶部添加面包屑/返回按钮(与其他页面一致)
|
||||||
|
- 左侧面板使用浅色变体
|
||||||
|
- 右侧内容区使用白色背景
|
||||||
|
|
||||||
|
3. **动画优化**
|
||||||
|
- 保留关键动画(生成按钮、加载动画)
|
||||||
|
- 简化背景动画(减少动画数量)
|
||||||
|
- 统一过渡时间(0.3s)
|
||||||
|
|
||||||
|
**优点:** 既保留创新感,又提升统一性
|
||||||
|
**缺点:** 需要较多调整工作
|
||||||
|
|
||||||
|
#### 方案C:品牌双主题(适合大型平台)
|
||||||
|
**目标:** 建立明确的双主题设计系统
|
||||||
|
|
||||||
|
**调整内容:**
|
||||||
|
1. **主题切换**
|
||||||
|
- 在设置中提供主题切换选项
|
||||||
|
- 标准业务使用浅色主题
|
||||||
|
- AI创新功能使用深色主题
|
||||||
|
- 统一过渡动画
|
||||||
|
|
||||||
|
2. **主题桥接**
|
||||||
|
- 在AI页面顶部添加主题标识
|
||||||
|
- 使用渐变过渡效果
|
||||||
|
- 统一图标和字体
|
||||||
|
|
||||||
|
3. **文档规范**
|
||||||
|
- 明确两套主题的使用场景
|
||||||
|
- 制定切换规则
|
||||||
|
- 统一组件库
|
||||||
|
|
||||||
|
**优点:** 灵活性高,可支持品牌升级
|
||||||
|
**缺点:** 开发和维护成本高
|
||||||
|
|
||||||
|
### 快速优化建议(不改变整体风格)
|
||||||
|
|
||||||
|
如果暂时不做大规模调整,可以先做以下小优化:
|
||||||
|
|
||||||
|
1. **统一圆角**
|
||||||
|
- 将3D页面的圆角从12-20px调整为8-12px
|
||||||
|
|
||||||
|
2. **添加面包屑**
|
||||||
|
- 在3D页面顶部添加返回路径
|
||||||
|
|
||||||
|
3. **统一过渡时间**
|
||||||
|
- 将所有动画过渡统一为0.3s
|
||||||
|
|
||||||
|
4. **添加品牌标识**
|
||||||
|
- 在3D页面显著位置添加系统Logo
|
||||||
|
|
||||||
|
5. **统一字体**
|
||||||
|
- 确保字体大小和行高与其他页面一致
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📚 参考资源
|
||||||
|
|
||||||
|
### 设计规范
|
||||||
|
- [Ant Design 设计价值观](https://ant.design/docs/spec/values-cn)
|
||||||
|
- [Material Design 色彩系统](https://material.io/design/color)
|
||||||
|
- [8点网格系统](https://spec.fm/specifics/8-pt-grid)
|
||||||
|
|
||||||
|
### 颜色工具
|
||||||
|
- [Coolors](https://coolors.co/) - 配色方案生成
|
||||||
|
- [Adobe Color](https://color.adobe.com/) - 色彩搭配
|
||||||
|
- [Contrast Checker](https://webaim.org/resources/contrastchecker/) - 对比度检查
|
||||||
|
|
||||||
|
### 组件库文档
|
||||||
|
- [Ant Design Vue](https://antdv.com/components/overview-cn)
|
||||||
|
- [Tailwind CSS](https://tailwindcss.com/docs)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📝 更新日志
|
||||||
|
|
||||||
|
### v1.0 (2026-01-14)
|
||||||
|
- ✅ 初始版本
|
||||||
|
- ✅ 完成主题色彩系统梳理
|
||||||
|
- ✅ 完成布局规范定义
|
||||||
|
- ✅ 完成组件规范文档
|
||||||
|
- ✅ 完成双主题对比分析
|
||||||
|
- ✅ 提出风格统一方案
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📞 联系与反馈
|
||||||
|
|
||||||
|
如有设计系统相关问题或建议,请通过以下方式反馈:
|
||||||
|
- 项目路径: `C:\Users\82788\Desktop\work\competition-management-system`
|
||||||
|
- 文档位置: `.claude/ui-design-system.md`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**文档结束**
|
||||||
1
.claude/worktrees/inspiring-diffie
Submodule
1
.claude/worktrees/inspiring-diffie
Submodule
@ -0,0 +1 @@
|
|||||||
|
Subproject commit 5d34307a698d7187d006385a41fd926641a66e25
|
||||||
1
.claude/worktrees/objective-yalow
Submodule
1
.claude/worktrees/objective-yalow
Submodule
@ -0,0 +1 @@
|
|||||||
|
Subproject commit 5d34307a698d7187d006385a41fd926641a66e25
|
||||||
1
.claude/worktrees/romantic-brattain
Submodule
1
.claude/worktrees/romantic-brattain
Submodule
@ -0,0 +1 @@
|
|||||||
|
Subproject commit 5d34307a698d7187d006385a41fd926641a66e25
|
||||||
156
.cursor/CHROME_DEVTOOLS_MCP_SETUP.md
Normal file
156
.cursor/CHROME_DEVTOOLS_MCP_SETUP.md
Normal file
@ -0,0 +1,156 @@
|
|||||||
|
# Chrome DevTools MCP 安装和配置说明
|
||||||
|
|
||||||
|
## ✅ 安装状态
|
||||||
|
|
||||||
|
chrome-devtools-mcp 已通过 pnpm 全局安装完成。
|
||||||
|
|
||||||
|
## 📝 配置步骤
|
||||||
|
|
||||||
|
### ✅ 已配置(推荐方式)
|
||||||
|
|
||||||
|
项目已配置使用包装脚本,确保使用正确的 Node.js 版本。配置文件位于 `.cursor/mcp.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"chrome-devtools": {
|
||||||
|
"command": "/Users/wwzh/Awesome/runfast/competition-management-system/.cursor/scripts/chrome-devtools-mcp.sh"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 方法 1:在 Cursor 用户设置中配置(备选)
|
||||||
|
|
||||||
|
如果项目配置不工作,可以在 Cursor 用户设置中添加:
|
||||||
|
|
||||||
|
1. 打开 Cursor
|
||||||
|
2. 按 `Cmd + Shift + P` (macOS) 或 `Ctrl + Shift + P` (Windows/Linux) 打开命令面板
|
||||||
|
3. 输入 "Preferences: Open User Settings (JSON)"
|
||||||
|
4. 在 `settings.json` 文件中添加以下配置:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"chrome-devtools": {
|
||||||
|
"command": "/Users/wwzh/Awesome/runfast/competition-management-system/.cursor/scripts/chrome-devtools-mcp.sh"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 方法 2:使用 npx(需要修复 npm 缓存权限)
|
||||||
|
|
||||||
|
如果 npm 缓存权限问题已修复,可以使用:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"chrome-devtools": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["chrome-devtools-mcp@latest"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**修复 npm 缓存权限**(需要 sudo 权限):
|
||||||
|
```bash
|
||||||
|
sudo chown -R $(whoami) ~/.npm
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔍 验证安装
|
||||||
|
|
||||||
|
安装完成后,重启 Cursor,然后在 Chat 中应该可以看到 Chrome DevTools MCP 相关的工具。
|
||||||
|
|
||||||
|
## 📚 使用说明
|
||||||
|
|
||||||
|
Chrome DevTools MCP 提供了以下功能:
|
||||||
|
- 浏览器导航和页面快照
|
||||||
|
- 控制台消息查看
|
||||||
|
- 网络请求监控
|
||||||
|
- 页面元素交互(点击、输入等)
|
||||||
|
- 截图功能
|
||||||
|
|
||||||
|
## ⚠️ 注意事项
|
||||||
|
|
||||||
|
1. **Node.js 版本要求**:建议使用 Node.js 22.12.0 或更高版本(当前版本:20.19.0 LTS)
|
||||||
|
2. **Chrome 浏览器**:需要安装最新版本的 Google Chrome
|
||||||
|
3. **首次使用**:可能需要登录配置,之后会保存登录状态
|
||||||
|
|
||||||
|
## 🔧 故障排除
|
||||||
|
|
||||||
|
### 问题:MCP 服务器启动失败
|
||||||
|
|
||||||
|
**检查步骤:**
|
||||||
|
|
||||||
|
1. **验证包装脚本是否可执行**:
|
||||||
|
```bash
|
||||||
|
cd /Users/wwzh/Awesome/runfast/competition-management-system
|
||||||
|
source ~/.nvm/nvm.sh
|
||||||
|
.cursor/scripts/chrome-devtools-mcp.sh --version
|
||||||
|
```
|
||||||
|
应该输出:`0.10.2`
|
||||||
|
|
||||||
|
2. **检查 Node.js 版本**:
|
||||||
|
```bash
|
||||||
|
source ~/.nvm/nvm.sh
|
||||||
|
node --version
|
||||||
|
```
|
||||||
|
应该显示:`v20.19.0`
|
||||||
|
|
||||||
|
3. **检查配置文件**:
|
||||||
|
```bash
|
||||||
|
cat .cursor/mcp.json
|
||||||
|
```
|
||||||
|
确认路径正确
|
||||||
|
|
||||||
|
4. **手动测试运行**:
|
||||||
|
```bash
|
||||||
|
source ~/.nvm/nvm.sh
|
||||||
|
node /Users/wwzh/Library/pnpm/global/5/.pnpm/chrome-devtools-mcp@0.10.2/node_modules/chrome-devtools-mcp/build/src/index.js --version
|
||||||
|
```
|
||||||
|
|
||||||
|
5. **检查 Cursor 日志**:
|
||||||
|
- 打开 Cursor
|
||||||
|
- 查看输出面板(View → Output)
|
||||||
|
- 选择 "MCP" 或 "Chrome DevTools" 查看错误信息
|
||||||
|
|
||||||
|
6. **重启 Cursor IDE**:
|
||||||
|
配置更改后需要完全重启 Cursor
|
||||||
|
|
||||||
|
### 常见错误
|
||||||
|
|
||||||
|
**错误:command not found**
|
||||||
|
- 确保包装脚本路径正确
|
||||||
|
- 检查脚本是否有执行权限:`chmod +x .cursor/scripts/chrome-devtools-mcp.sh`
|
||||||
|
|
||||||
|
**错误:Node.js version mismatch**
|
||||||
|
- 确保使用 Node.js 20.19.0:`nvm use 20.19.0`
|
||||||
|
- 检查包装脚本中的 nvm 路径是否正确
|
||||||
|
|
||||||
|
**错误:npm cache permission denied**
|
||||||
|
- 如果使用 npx 方式,需要修复权限:
|
||||||
|
```bash
|
||||||
|
sudo chown -R $(whoami) ~/.npm
|
||||||
|
```
|
||||||
|
|
||||||
|
### 重新安装
|
||||||
|
|
||||||
|
如果问题持续存在:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. 卸载旧版本
|
||||||
|
pnpm remove -g chrome-devtools-mcp
|
||||||
|
|
||||||
|
# 2. 清理缓存
|
||||||
|
pnpm store prune
|
||||||
|
|
||||||
|
# 3. 重新安装
|
||||||
|
source ~/.nvm/nvm.sh
|
||||||
|
pnpm add -g chrome-devtools-mcp@latest
|
||||||
|
|
||||||
|
# 4. 验证安装
|
||||||
|
pnpm list -g chrome-devtools-mcp
|
||||||
|
```
|
||||||
|
|
||||||
167
.cursor/MIGRATION_SUMMARY.md
Normal file
167
.cursor/MIGRATION_SUMMARY.md
Normal file
@ -0,0 +1,167 @@
|
|||||||
|
# Cursor Rules 迁移总结
|
||||||
|
|
||||||
|
## ✅ 完成的改进
|
||||||
|
|
||||||
|
根据 [Cursor 官方文档](https://cursor.com/cn/docs/context/rules) 的最佳实践,已将项目规则系统现代化。
|
||||||
|
|
||||||
|
### 1. 规则拆分 ✨
|
||||||
|
|
||||||
|
原来的 283 行单一文件 `.cursorrules` 已拆分为 **8 个模块化规则**:
|
||||||
|
|
||||||
|
#### 主规则(`.cursor/rules/`)
|
||||||
|
|
||||||
|
| 规则文件 | 类型 | 大小 | 说明 |
|
||||||
|
|---------|------|------|------|
|
||||||
|
| `project-overview.mdc` | Always Apply | ~50 行 | 项目概述和技术栈 |
|
||||||
|
| `multi-tenant.mdc` | Always Apply | ~100 行 | ⚠️ 多租户隔离规范(核心安全) |
|
||||||
|
| `backend-architecture.mdc` | Apply to Files | ~200 行 | NestJS 后端架构规范 |
|
||||||
|
| `frontend-architecture.mdc` | Apply to Files | ~250 行 | Vue 3 前端架构规范 |
|
||||||
|
| `database-design.mdc` | Apply to Files | ~200 行 | Prisma 数据库设计规范 |
|
||||||
|
| `code-review-checklist.mdc` | Manual | ~150 行 | 代码审查清单 |
|
||||||
|
|
||||||
|
#### 嵌套规则
|
||||||
|
|
||||||
|
| 规则文件 | 作用域 | 说明 |
|
||||||
|
|---------|--------|------|
|
||||||
|
| `backend/.cursor/rules/backend-specific.mdc` | backend/ | 后端特定规范和脚本 |
|
||||||
|
| `frontend/.cursor/rules/frontend-specific.mdc` | frontend/ | 前端特定规范和组件 |
|
||||||
|
|
||||||
|
### 2. 使用 MDC 格式 📝
|
||||||
|
|
||||||
|
所有规则文件使用标准 MDC 格式,支持元数据:
|
||||||
|
|
||||||
|
```md
|
||||||
|
---
|
||||||
|
description: 规则描述
|
||||||
|
globs:
|
||||||
|
- "backend/**/*.ts"
|
||||||
|
alwaysApply: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# 规则内容...
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. 智能应用策略 🎯
|
||||||
|
|
||||||
|
- **Always Apply**: 关键规则(项目概述、多租户)始终生效
|
||||||
|
- **File Matching**: 后端/前端规则仅在相关文件时应用
|
||||||
|
- **Nested Rules**: 子目录规则只在该目录下生效
|
||||||
|
- **Manual**: 代码审查清单按需引用 `@code-review-checklist`
|
||||||
|
|
||||||
|
### 4. 创建 AGENTS.md 🚀
|
||||||
|
|
||||||
|
添加了简化版快速参考文件:
|
||||||
|
- 纯 Markdown 格式,无元数据
|
||||||
|
- 包含最重要的规则和快速参考
|
||||||
|
- 易于阅读和分享
|
||||||
|
|
||||||
|
### 5. 完整文档 📚
|
||||||
|
|
||||||
|
创建了详细的使用指南 `.cursor/RULES_README.md`:
|
||||||
|
- 规则文件结构说明
|
||||||
|
- 使用方式指导
|
||||||
|
- 迁移指南
|
||||||
|
- 最佳实践
|
||||||
|
|
||||||
|
## 📊 改进效果
|
||||||
|
|
||||||
|
### 性能优化
|
||||||
|
- ✅ 每个规则 < 500 行(符合最佳实践)
|
||||||
|
- ✅ 按需加载,减少不必要的上下文
|
||||||
|
- ✅ 嵌套规则提高针对性
|
||||||
|
|
||||||
|
### 可维护性
|
||||||
|
- ✅ 模块化设计,易于更新单个规则
|
||||||
|
- ✅ 版本控制友好
|
||||||
|
- ✅ 清晰的职责分离
|
||||||
|
|
||||||
|
### 可扩展性
|
||||||
|
- ✅ 轻松添加新规则
|
||||||
|
- ✅ 支持子目录特定规则
|
||||||
|
- ✅ 规则可以引用其他文件
|
||||||
|
|
||||||
|
## 🎯 使用建议
|
||||||
|
|
||||||
|
### 日常开发
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 开发时规则自动生效
|
||||||
|
# 不需要手动操作
|
||||||
|
|
||||||
|
# 需要代码审查时
|
||||||
|
在 Chat 中输入:@code-review-checklist
|
||||||
|
```
|
||||||
|
|
||||||
|
### 添加新规则
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 方法 1: 使用命令
|
||||||
|
Cmd/Ctrl + Shift + P → "New Cursor Rule"
|
||||||
|
|
||||||
|
# 方法 2: 手动创建
|
||||||
|
# 在 .cursor/rules/ 创建新的 .mdc 文件
|
||||||
|
```
|
||||||
|
|
||||||
|
### 查看规则状态
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 打开 Cursor Settings
|
||||||
|
Cmd/Ctrl + ,
|
||||||
|
|
||||||
|
# 进入 Rules 选项卡
|
||||||
|
查看所有规则的状态和类型
|
||||||
|
```
|
||||||
|
|
||||||
|
## ⚠️ 重要变更
|
||||||
|
|
||||||
|
### 1. 旧文件状态
|
||||||
|
- `.cursorrules` 已标记为 DEPRECATED
|
||||||
|
- 文件保留作为备份
|
||||||
|
- 所有功能已迁移到新系统
|
||||||
|
|
||||||
|
### 2. 多租户规则
|
||||||
|
- 设为 **Always Apply**
|
||||||
|
- 确保所有生成的代码都包含租户隔离检查
|
||||||
|
- 这是系统安全的核心保障
|
||||||
|
|
||||||
|
### 3. 嵌套规则生效
|
||||||
|
- 在 `backend/` 目录工作时,后端特定规则自动应用
|
||||||
|
- 在 `frontend/` 目录工作时,前端特定规则自动应用
|
||||||
|
|
||||||
|
## 📈 下一步
|
||||||
|
|
||||||
|
### 可选的进一步优化
|
||||||
|
|
||||||
|
1. **添加模块特定规则**
|
||||||
|
```
|
||||||
|
backend/src/contests/.cursor/rules/
|
||||||
|
└── contests-specific.mdc
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **创建模板规则**
|
||||||
|
- 控制器模板
|
||||||
|
- 服务模板
|
||||||
|
- 组件模板
|
||||||
|
|
||||||
|
3. **团队规则(如果有 Team 计划)**
|
||||||
|
- 在 Cursor Dashboard 配置团队级规则
|
||||||
|
- 强制执行组织标准
|
||||||
|
|
||||||
|
## 🔗 相关资源
|
||||||
|
|
||||||
|
- 📖 [规则使用指南](./.cursor/RULES_README.md)
|
||||||
|
- 🚀 [快速参考](../AGENTS.md)
|
||||||
|
- 📚 [Cursor 官方文档](https://cursor.com/cn/docs/context/rules)
|
||||||
|
|
||||||
|
## 💬 反馈
|
||||||
|
|
||||||
|
如有问题或建议,可以:
|
||||||
|
1. 更新规则文件并测试
|
||||||
|
2. 查看官方文档获取最新功能
|
||||||
|
3. 分享最佳实践给团队
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**迁移完成时间**: 2025-11-27
|
||||||
|
**符合标准**: Cursor Rules Best Practices v1.0
|
||||||
|
|
||||||
128
.cursor/RULES_README.md
Normal file
128
.cursor/RULES_README.md
Normal file
@ -0,0 +1,128 @@
|
|||||||
|
# Cursor Rules 使用指南
|
||||||
|
|
||||||
|
本项目使用 Cursor 的新规则系统(Project Rules + AGENTS.md),遵循 [官方最佳实践](https://cursor.com/cn/docs/context/rules)。
|
||||||
|
|
||||||
|
## 📁 规则文件结构
|
||||||
|
|
||||||
|
```
|
||||||
|
competition-management-system/
|
||||||
|
├── .cursor/rules/ # 项目规则目录
|
||||||
|
│ ├── project-overview.mdc # 项目概述(Always Apply)
|
||||||
|
│ ├── multi-tenant.mdc # 多租户规范(Always Apply)⚠️
|
||||||
|
│ ├── backend-architecture.mdc # 后端架构(Apply to backend files)
|
||||||
|
│ ├── frontend-architecture.mdc # 前端架构(Apply to frontend files)
|
||||||
|
│ ├── database-design.mdc # 数据库设计(Apply to prisma files)
|
||||||
|
│ └── code-review-checklist.mdc # 代码审查清单(Manual)
|
||||||
|
├── backend/.cursor/rules/
|
||||||
|
│ └── backend-specific.mdc # 后端特定规范(嵌套规则)
|
||||||
|
├── frontend/.cursor/rules/
|
||||||
|
│ └── frontend-specific.mdc # 前端特定规范(嵌套规则)
|
||||||
|
├── AGENTS.md # 简化版指令(Quick Reference)
|
||||||
|
└── .cursorrules # 已废弃,保留作为备份
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎯 规则类型说明
|
||||||
|
|
||||||
|
### 1. Always Apply(总是应用)
|
||||||
|
- `project-overview.mdc` - 项目技术栈和基本信息
|
||||||
|
- `multi-tenant.mdc` - **多租户数据隔离规范(最重要)**
|
||||||
|
|
||||||
|
### 2. Apply to Specific Files(文件匹配)
|
||||||
|
- `backend-architecture.mdc` - 匹配 `backend/**/*.ts`
|
||||||
|
- `frontend-architecture.mdc` - 匹配 `frontend/**/*.vue` 和 `frontend/**/*.ts`
|
||||||
|
- `database-design.mdc` - 匹配 `backend/prisma/**/*.prisma`
|
||||||
|
|
||||||
|
### 3. Nested Rules(嵌套规则)
|
||||||
|
- `backend/.cursor/rules/backend-specific.mdc` - 仅作用于 backend 目录
|
||||||
|
- `frontend/.cursor/rules/frontend-specific.mdc` - 仅作用于 frontend 目录
|
||||||
|
|
||||||
|
### 4. Apply Manually(手动触发)
|
||||||
|
- `code-review-checklist.mdc` - 在 Chat 中使用 `@code-review-checklist` 引用
|
||||||
|
|
||||||
|
## 🚀 使用方式
|
||||||
|
|
||||||
|
### 在 Chat 中引用规则
|
||||||
|
|
||||||
|
```
|
||||||
|
# 自动应用
|
||||||
|
规则会根据上下文自动应用
|
||||||
|
|
||||||
|
# 手动引用
|
||||||
|
@code-review-checklist 请检查我的代码
|
||||||
|
|
||||||
|
# 引用特定文件
|
||||||
|
@backend-architecture 如何创建一个新的模块?
|
||||||
|
```
|
||||||
|
|
||||||
|
### 查看和管理规则
|
||||||
|
|
||||||
|
1. 打开 Cursor Settings(Cmd/Ctrl + ,)
|
||||||
|
2. 进入 **Rules** 选项卡
|
||||||
|
3. 查看所有规则的状态和类型
|
||||||
|
|
||||||
|
### 编辑规则
|
||||||
|
|
||||||
|
直接编辑 `.cursor/rules/` 目录中的 `.mdc` 文件,Cursor 会自动重新加载。
|
||||||
|
|
||||||
|
## 📖 快速参考
|
||||||
|
|
||||||
|
### 对于快速查阅
|
||||||
|
使用 `AGENTS.md`(纯 Markdown,无元数据):
|
||||||
|
```bash
|
||||||
|
cat AGENTS.md
|
||||||
|
```
|
||||||
|
|
||||||
|
### 对于详细规范
|
||||||
|
查看 `.cursor/rules/` 中的具体规则文件。
|
||||||
|
|
||||||
|
## 🔄 从旧版本迁移
|
||||||
|
|
||||||
|
旧的 `.cursorrules` 文件已被拆分为多个小规则文件:
|
||||||
|
|
||||||
|
| 旧内容 | 新位置 |
|
||||||
|
|-------|--------|
|
||||||
|
| 项目概述 | `project-overview.mdc` |
|
||||||
|
| 后端规范 | `backend-architecture.mdc` + `backend-specific.mdc` |
|
||||||
|
| 前端规范 | `frontend-architecture.mdc` + `frontend-specific.mdc` |
|
||||||
|
| 数据库规范 | `database-design.mdc` |
|
||||||
|
| 多租户规范 | `multi-tenant.mdc` |
|
||||||
|
| 代码审查 | `code-review-checklist.mdc` |
|
||||||
|
|
||||||
|
## 💡 最佳实践
|
||||||
|
|
||||||
|
### 1. 规则大小
|
||||||
|
- 每个规则文件 < 500 行
|
||||||
|
- 聚焦单一主题
|
||||||
|
- 提供具体示例
|
||||||
|
|
||||||
|
### 2. 嵌套规则
|
||||||
|
- 在子目录创建 `.cursor/rules/` 针对特定区域
|
||||||
|
- 子规则会与父规则合并
|
||||||
|
- 更具体的规则优先级更高
|
||||||
|
|
||||||
|
### 3. 规则复用
|
||||||
|
- 将重复的提示词转换为规则
|
||||||
|
- 使用 `@rule-name` 在对话中引用
|
||||||
|
- 避免每次重复输入相同指令
|
||||||
|
|
||||||
|
## ⚠️ 重要提醒
|
||||||
|
|
||||||
|
### 多租户隔离
|
||||||
|
`multi-tenant.mdc` 规则设为 **Always Apply**,确保所有代码生成都包含租户隔离检查。这是系统安全的核心!
|
||||||
|
|
||||||
|
### 规则优先级
|
||||||
|
规则应用顺序:**Team Rules → Project Rules → User Rules**
|
||||||
|
|
||||||
|
## 🔗 参考链接
|
||||||
|
|
||||||
|
- [Cursor Rules 官方文档](https://cursor.com/cn/docs/context/rules)
|
||||||
|
- [MDC 格式说明](https://cursor.com/cn/docs/context/rules#规则结构)
|
||||||
|
- [最佳实践](https://cursor.com/cn/docs/context/rules#最佳实践)
|
||||||
|
|
||||||
|
## 📝 更新日志
|
||||||
|
|
||||||
|
- **2025-11-27**: 从 `.cursorrules` 迁移到新的 Project Rules 系统
|
||||||
|
- 拆分为 6 个主规则 + 2 个嵌套规则
|
||||||
|
- 添加 AGENTS.md 作为快速参考
|
||||||
|
- 遵循 Cursor 官方最佳实践
|
||||||
|
|
||||||
7
.cursor/mcp.json
Normal file
7
.cursor/mcp.json
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"chrome-devtools": {
|
||||||
|
"command": "/Users/wwzh/Awesome/runfast/competition-management-system/.cursor/scripts/chrome-devtools-mcp.sh"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
221
.cursor/rules/backend-architecture.mdc
Normal file
221
.cursor/rules/backend-architecture.mdc
Normal file
@ -0,0 +1,221 @@
|
|||||||
|
---
|
||||||
|
description: NestJS 后端架构规范和模块结构
|
||||||
|
globs:
|
||||||
|
- "backend/**/*.ts"
|
||||||
|
alwaysApply: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# 后端架构规范
|
||||||
|
|
||||||
|
## 模块结构
|
||||||
|
|
||||||
|
每个功能模块应包含:
|
||||||
|
|
||||||
|
- `module.ts` - 模块定义
|
||||||
|
- `controller.ts` - 控制器
|
||||||
|
- `service.ts` - 服务层
|
||||||
|
- `dto/` - 数据传输对象目录
|
||||||
|
|
||||||
|
### 命名规范
|
||||||
|
|
||||||
|
- 模块命名使用复数形式:`users`, `roles`, `contests`
|
||||||
|
- 子模块放在父模块目录下:`contests/works/`, `contests/teams/`
|
||||||
|
|
||||||
|
### 目录结构示例
|
||||||
|
|
||||||
|
```
|
||||||
|
src/
|
||||||
|
├── contests/
|
||||||
|
│ ├── contests.module.ts
|
||||||
|
│ ├── contests/
|
||||||
|
│ │ ├── contests.module.ts
|
||||||
|
│ │ ├── contests.controller.ts
|
||||||
|
│ │ ├── contests.service.ts
|
||||||
|
│ │ └── dto/
|
||||||
|
│ ├── works/
|
||||||
|
│ │ ├── works.module.ts
|
||||||
|
│ │ ├── works.controller.ts
|
||||||
|
│ │ ├── works.service.ts
|
||||||
|
│ │ └── dto/
|
||||||
|
│ └── teams/
|
||||||
|
│ └── ...
|
||||||
|
```
|
||||||
|
|
||||||
|
## 服务层 (Service)
|
||||||
|
|
||||||
|
### 基本规范
|
||||||
|
|
||||||
|
- 使用 `@Injectable()` 装饰器
|
||||||
|
- 构造函数注入依赖,使用 `private readonly`
|
||||||
|
- 所有数据库操作通过 PrismaService
|
||||||
|
- **禁止直接使用 SQL**
|
||||||
|
|
||||||
|
### 标准方法命名
|
||||||
|
|
||||||
|
- `create` - 创建
|
||||||
|
- `findAll` - 查询列表(支持分页)
|
||||||
|
- `findOne` - 查询单个
|
||||||
|
- `update` - 更新
|
||||||
|
- `remove` - 删除(软删除或级联)
|
||||||
|
|
||||||
|
### 示例
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
@Injectable()
|
||||||
|
export class UsersService {
|
||||||
|
constructor(private readonly prisma: PrismaService) {}
|
||||||
|
|
||||||
|
async create(createDto: CreateUserDto, tenantId: number) {
|
||||||
|
return this.prisma.user.create({
|
||||||
|
data: {
|
||||||
|
...createDto,
|
||||||
|
tenantId,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async findAll(tenantId: number, skip?: number, take?: number) {
|
||||||
|
return this.prisma.user.findMany({
|
||||||
|
where: { tenantId, validState: 1 },
|
||||||
|
skip,
|
||||||
|
take,
|
||||||
|
include: {
|
||||||
|
roles: {
|
||||||
|
include: { role: true },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 控制器层 (Controller)
|
||||||
|
|
||||||
|
### 基本规范
|
||||||
|
|
||||||
|
- 使用 `@Controller()` 装饰器,路径使用复数形式
|
||||||
|
- 所有路由默认需要认证(除非使用 `@Public()` 装饰器)
|
||||||
|
- 使用 REST 风格的 HTTP 方法装饰器
|
||||||
|
|
||||||
|
### 装饰器使用
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
@Controller("users")
|
||||||
|
export class UsersController {
|
||||||
|
constructor(private readonly usersService: UsersService) {}
|
||||||
|
|
||||||
|
@Post()
|
||||||
|
@RequirePermission("user:create")
|
||||||
|
async create(
|
||||||
|
@Body() createDto: CreateUserDto,
|
||||||
|
@CurrentTenantId() tenantId: number,
|
||||||
|
@CurrentUser() user: any
|
||||||
|
) {
|
||||||
|
return this.usersService.create(createDto, tenantId);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Get()
|
||||||
|
@RequirePermission("user:read")
|
||||||
|
async findAll(
|
||||||
|
@CurrentTenantId() tenantId: number,
|
||||||
|
@Query("skip") skip?: number,
|
||||||
|
@Query("take") take?: number
|
||||||
|
) {
|
||||||
|
return this.usersService.findAll(tenantId, skip, take);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Public()
|
||||||
|
@Get("public-info")
|
||||||
|
async getPublicInfo() {
|
||||||
|
return { version: "1.0.0" };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 常用装饰器
|
||||||
|
|
||||||
|
- `@CurrentTenantId()` - 获取当前租户ID
|
||||||
|
- `@CurrentUser()` - 获取当前用户信息
|
||||||
|
- `@RequirePermission('module:action')` - 权限检查
|
||||||
|
- `@Public()` - 公开接口,无需认证
|
||||||
|
|
||||||
|
## DTO 规范
|
||||||
|
|
||||||
|
### 命名规范
|
||||||
|
|
||||||
|
- 创建:`CreateXxxDto`
|
||||||
|
- 更新:`UpdateXxxDto`
|
||||||
|
- 查询:`QueryXxxDto`
|
||||||
|
|
||||||
|
### 验证规则
|
||||||
|
|
||||||
|
使用 `class-validator` 装饰器:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
IsString,
|
||||||
|
IsEmail,
|
||||||
|
IsOptional,
|
||||||
|
IsArray,
|
||||||
|
IsNumber,
|
||||||
|
} from "class-validator";
|
||||||
|
|
||||||
|
export class CreateUserDto {
|
||||||
|
@IsString()
|
||||||
|
username: string;
|
||||||
|
|
||||||
|
@IsString()
|
||||||
|
password: string;
|
||||||
|
|
||||||
|
@IsString()
|
||||||
|
nickname: string;
|
||||||
|
|
||||||
|
@IsEmail()
|
||||||
|
@IsOptional()
|
||||||
|
email?: string;
|
||||||
|
|
||||||
|
@IsArray()
|
||||||
|
@IsNumber({}, { each: true })
|
||||||
|
@IsOptional()
|
||||||
|
roleIds?: number[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 错误处理
|
||||||
|
|
||||||
|
使用 NestJS 内置异常,消息使用中文:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
NotFoundException,
|
||||||
|
BadRequestException,
|
||||||
|
UnauthorizedException,
|
||||||
|
ForbiddenException,
|
||||||
|
} from "@nestjs/common";
|
||||||
|
|
||||||
|
// 示例
|
||||||
|
if (!user) {
|
||||||
|
throw new NotFoundException("用户不存在");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!isValid) {
|
||||||
|
throw new BadRequestException("数据验证失败");
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 权限控制
|
||||||
|
|
||||||
|
权限字符串格式:`模块:操作`
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
@RequirePermission('contest:create') // 创建竞赛
|
||||||
|
@RequirePermission('user:update') // 更新用户
|
||||||
|
@RequirePermission('role:delete') // 删除角色
|
||||||
|
```
|
||||||
|
|
||||||
|
## 代码风格
|
||||||
|
|
||||||
|
- 导入顺序:NestJS 核心 → 第三方库 → 本地模块
|
||||||
|
- 使用 async/await,避免 Promise.then()
|
||||||
|
- 使用解构赋值提高代码可读性
|
||||||
|
- 复杂逻辑必须添加注释
|
||||||
112
.cursor/rules/code-review-checklist.mdc
Normal file
112
.cursor/rules/code-review-checklist.mdc
Normal file
@ -0,0 +1,112 @@
|
|||||||
|
---
|
||||||
|
description: 代码审查检查清单(手动应用)
|
||||||
|
globs:
|
||||||
|
alwaysApply: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# 代码审查检查清单
|
||||||
|
|
||||||
|
在提交代码前,请确保以下各项都已检查:
|
||||||
|
|
||||||
|
## 多租户数据隔离
|
||||||
|
|
||||||
|
- [ ] 所有数据库查询包含 `tenantId` 条件
|
||||||
|
- [ ] 创建数据时设置了 `tenantId`
|
||||||
|
- [ ] 更新/删除操作验证了 `tenantId`
|
||||||
|
- [ ] 新的 Prisma 模型包含了必需的审计字段
|
||||||
|
|
||||||
|
## 数据验证
|
||||||
|
|
||||||
|
- [ ] DTO 验证规则完整
|
||||||
|
- [ ] 前端和后端都进行了数据验证
|
||||||
|
- [ ] 使用了 TypeScript 类型定义
|
||||||
|
- [ ] 处理了所有必填字段
|
||||||
|
|
||||||
|
## 错误处理
|
||||||
|
|
||||||
|
- [ ] 所有异步操作都有错误处理
|
||||||
|
- [ ] 错误信息清晰明确
|
||||||
|
- [ ] 使用了合适的 HTTP 状态码
|
||||||
|
- [ ] 前端显示了友好的错误提示
|
||||||
|
|
||||||
|
## 权限控制
|
||||||
|
|
||||||
|
- [ ] 后端使用了 `@RequirePermission()` 装饰器
|
||||||
|
- [ ] 前端路由配置了 `permissions` meta
|
||||||
|
- [ ] 权限验证失败返回 403
|
||||||
|
- [ ] 遵循最小权限原则
|
||||||
|
|
||||||
|
## 代码质量
|
||||||
|
|
||||||
|
- [ ] 代码格式符合 ESLint/Prettier 规范
|
||||||
|
- [ ] 复杂逻辑添加了注释
|
||||||
|
- [ ] 变量和函数命名清晰
|
||||||
|
- [ ] 无硬编码配置(使用环境变量)
|
||||||
|
- [ ] 无调试代码(console.log 等)
|
||||||
|
|
||||||
|
## 性能优化
|
||||||
|
|
||||||
|
- [ ] 数据库查询使用了 `include` 预加载
|
||||||
|
- [ ] 使用了 `select` 精简字段
|
||||||
|
- [ ] 实现了分页查询
|
||||||
|
- [ ] 避免了 N+1 查询
|
||||||
|
- [ ] 前端组件按需加载
|
||||||
|
|
||||||
|
## 安全性
|
||||||
|
|
||||||
|
- [ ] 敏感数据加密存储
|
||||||
|
- [ ] API 需要认证(除非 `@Public()`)
|
||||||
|
- [ ] 防止了 SQL 注入(使用 Prisma)
|
||||||
|
- [ ] 防止了 XSS 攻击
|
||||||
|
- [ ] Token 过期时间合理
|
||||||
|
|
||||||
|
## 测试
|
||||||
|
|
||||||
|
- [ ] 核心业务逻辑有单元测试
|
||||||
|
- [ ] 测试覆盖率 > 80%
|
||||||
|
- [ ] 所有测试通过
|
||||||
|
|
||||||
|
## Git 提交
|
||||||
|
|
||||||
|
- [ ] 提交信息清晰(使用中文)
|
||||||
|
- [ ] 提交信息格式:`类型: 描述`
|
||||||
|
- [ ] 一次提交只做一件事
|
||||||
|
- [ ] 不包含敏感信息
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
- [ ] 复杂功能有文档说明
|
||||||
|
- [ ] API 接口有注释
|
||||||
|
- [ ] README 更新(如有必要)
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
### 在提交前运行
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 后端
|
||||||
|
cd backend
|
||||||
|
pnpm lint # 代码检查
|
||||||
|
pnpm test # 运行测试
|
||||||
|
pnpm build # 确保能成功构建
|
||||||
|
|
||||||
|
# 前端
|
||||||
|
cd frontend
|
||||||
|
pnpm lint # 代码检查
|
||||||
|
pnpm build # 确保能成功构建
|
||||||
|
```
|
||||||
|
|
||||||
|
### 自动化检查
|
||||||
|
|
||||||
|
考虑使用 Git hooks(如 husky)自动执行检查:
|
||||||
|
- pre-commit: 运行 lint
|
||||||
|
- pre-push: 运行测试
|
||||||
|
|
||||||
|
### Code Review 关注点
|
||||||
|
|
||||||
|
审查他人代码时,重点关注:
|
||||||
|
1. **数据安全**:租户隔离是否完整
|
||||||
|
2. **权限控制**:是否正确验证权限
|
||||||
|
3. **错误处理**:是否处理所有异常情况
|
||||||
|
4. **代码质量**:是否易于理解和维护
|
||||||
|
5. **性能**:是否有明显的性能问题
|
||||||
278
.cursor/rules/database-design.mdc
Normal file
278
.cursor/rules/database-design.mdc
Normal file
@ -0,0 +1,278 @@
|
|||||||
|
---
|
||||||
|
description: Prisma 数据库设计规范和最佳实践
|
||||||
|
globs:
|
||||||
|
- "backend/prisma/**/*.prisma"
|
||||||
|
alwaysApply: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# 数据库设计规范
|
||||||
|
|
||||||
|
## Prisma Schema 规范
|
||||||
|
|
||||||
|
### 表结构要求
|
||||||
|
|
||||||
|
所有业务表必须包含以下字段:
|
||||||
|
|
||||||
|
```prisma
|
||||||
|
model YourModel {
|
||||||
|
id Int @id @default(autoincrement())
|
||||||
|
tenantId Int @map("tenant_id") /// 租户ID(必填)
|
||||||
|
|
||||||
|
// 业务字段...
|
||||||
|
name String
|
||||||
|
description String?
|
||||||
|
|
||||||
|
// 审计字段
|
||||||
|
validState Int @default(1) @map("valid_state") /// 1-有效,2-失效
|
||||||
|
creator Int? /// 创建人ID
|
||||||
|
modifier Int? /// 修改人ID
|
||||||
|
createTime DateTime @default(now()) @map("create_time")
|
||||||
|
modifyTime DateTime @updatedAt @map("modify_time")
|
||||||
|
|
||||||
|
// 关系
|
||||||
|
tenant Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
|
||||||
|
creatorUser User? @relation("YourModelCreator", fields: [creator], references: [id], onDelete: SetNull)
|
||||||
|
modifierUser User? @relation("YourModelModifier", fields: [modifier], references: [id], onDelete: SetNull)
|
||||||
|
|
||||||
|
@@map("your_table_name")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 字段命名规范
|
||||||
|
|
||||||
|
- Prisma 模型使用 camelCase:`tenantId`, `createTime`
|
||||||
|
- 数据库列使用 snake_case:`tenant_id`, `create_time`
|
||||||
|
- 使用 `@map()` 映射字段名
|
||||||
|
- 使用 `@@map()` 映射表名
|
||||||
|
|
||||||
|
### 状态字段
|
||||||
|
|
||||||
|
使用 `validState` 表示数据有效性:
|
||||||
|
|
||||||
|
- `1` - 有效
|
||||||
|
- `2` - 失效(软删除)
|
||||||
|
|
||||||
|
```prisma
|
||||||
|
validState Int @default(1) @map("valid_state")
|
||||||
|
```
|
||||||
|
|
||||||
|
## 关系设计
|
||||||
|
|
||||||
|
### 一对多关系
|
||||||
|
|
||||||
|
```prisma
|
||||||
|
model Tenant {
|
||||||
|
id Int @id @default(autoincrement())
|
||||||
|
users User[]
|
||||||
|
}
|
||||||
|
|
||||||
|
model User {
|
||||||
|
id Int @id @default(autoincrement())
|
||||||
|
tenantId Int @map("tenant_id")
|
||||||
|
tenant Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 多对多关系
|
||||||
|
|
||||||
|
使用显式中间表:
|
||||||
|
|
||||||
|
```prisma
|
||||||
|
model User {
|
||||||
|
id Int @id @default(autoincrement())
|
||||||
|
roles UserRole[]
|
||||||
|
}
|
||||||
|
|
||||||
|
model Role {
|
||||||
|
id Int @id @default(autoincrement())
|
||||||
|
users UserRole[]
|
||||||
|
}
|
||||||
|
|
||||||
|
model UserRole {
|
||||||
|
userId Int @map("user_id")
|
||||||
|
roleId Int @map("role_id")
|
||||||
|
user User @relation(fields: [userId], references: [id], onDelete: Cascade)
|
||||||
|
role Role @relation(fields: [roleId], references: [id], onDelete: Cascade)
|
||||||
|
|
||||||
|
@@id([userId, roleId])
|
||||||
|
@@map("user_roles")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 一对一关系
|
||||||
|
|
||||||
|
```prisma
|
||||||
|
model User {
|
||||||
|
id Int @id @default(autoincrement())
|
||||||
|
teacher Teacher?
|
||||||
|
}
|
||||||
|
|
||||||
|
model Teacher {
|
||||||
|
id Int @id @default(autoincrement())
|
||||||
|
userId Int @unique @map("user_id")
|
||||||
|
user User @relation(fields: [userId], references: [id], onDelete: Cascade)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 级联删除规则
|
||||||
|
|
||||||
|
- 强依赖关系:`onDelete: Cascade`
|
||||||
|
- 弱依赖关系:`onDelete: SetNull`(字段必须可选)
|
||||||
|
- 保护性关系:`onDelete: Restrict`
|
||||||
|
|
||||||
|
## 索引设计
|
||||||
|
|
||||||
|
### 自动索引
|
||||||
|
|
||||||
|
- 主键自动创建索引
|
||||||
|
- 外键字段自动创建索引
|
||||||
|
- `@unique` 字段自动创建唯一索引
|
||||||
|
|
||||||
|
### 复合索引
|
||||||
|
|
||||||
|
```prisma
|
||||||
|
model User {
|
||||||
|
tenantId Int
|
||||||
|
username String
|
||||||
|
|
||||||
|
@@unique([tenantId, username])
|
||||||
|
@@index([tenantId, validState])
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 性能优化索引
|
||||||
|
|
||||||
|
为频繁查询的字段添加索引:
|
||||||
|
|
||||||
|
```prisma
|
||||||
|
model Contest {
|
||||||
|
tenantId Int
|
||||||
|
status Int
|
||||||
|
startTime DateTime
|
||||||
|
|
||||||
|
@@index([tenantId, status])
|
||||||
|
@@index([tenantId, startTime])
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Prisma 查询最佳实践
|
||||||
|
|
||||||
|
### 使用 include 预加载关联
|
||||||
|
|
||||||
|
避免 N+1 查询问题:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ 好的做法 - 使用 include 预加载
|
||||||
|
const users = await prisma.user.findMany({
|
||||||
|
where: { tenantId },
|
||||||
|
include: {
|
||||||
|
roles: {
|
||||||
|
include: {
|
||||||
|
role: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// ❌ 不好的做法 - N+1 查询
|
||||||
|
const users = await prisma.user.findMany({
|
||||||
|
where: { tenantId },
|
||||||
|
});
|
||||||
|
for (const user of users) {
|
||||||
|
user.roles = await prisma.userRole.findMany({
|
||||||
|
where: { userId: user.id },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 使用 select 精简字段
|
||||||
|
|
||||||
|
只查询需要的字段:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const users = await prisma.user.findMany({
|
||||||
|
where: { tenantId },
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
username: true,
|
||||||
|
nickname: true,
|
||||||
|
// 不查询 password 等敏感字段
|
||||||
|
},
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### 分页查询
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const users = await prisma.user.findMany({
|
||||||
|
where: { tenantId, validState: 1 },
|
||||||
|
skip: (page - 1) * pageSize,
|
||||||
|
take: pageSize,
|
||||||
|
orderBy: { createTime: "desc" },
|
||||||
|
});
|
||||||
|
|
||||||
|
const total = await prisma.user.count({
|
||||||
|
where: { tenantId, validState: 1 },
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### 事务处理
|
||||||
|
|
||||||
|
使用 `$transaction` 确保数据一致性:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
await prisma.$transaction(async (tx) => {
|
||||||
|
// 创建用户
|
||||||
|
const user = await tx.user.create({
|
||||||
|
data: {
|
||||||
|
username: "test",
|
||||||
|
tenantId,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// 创建用户角色关联
|
||||||
|
await tx.userRole.createMany({
|
||||||
|
data: roleIds.map((roleId) => ({
|
||||||
|
userId: user.id,
|
||||||
|
roleId,
|
||||||
|
})),
|
||||||
|
});
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## 数据迁移
|
||||||
|
|
||||||
|
### 创建迁移
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 开发环境 - 创建并应用迁移
|
||||||
|
pnpm prisma:migrate:dev
|
||||||
|
|
||||||
|
# 生产环境 - 只应用迁移
|
||||||
|
pnpm prisma:migrate:deploy
|
||||||
|
```
|
||||||
|
|
||||||
|
### 迁移命名
|
||||||
|
|
||||||
|
使用描述性的迁移名称:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
prisma migrate dev --name add_contest_module
|
||||||
|
prisma migrate dev --name add_user_avatar_field
|
||||||
|
```
|
||||||
|
|
||||||
|
### 迁移注意事项
|
||||||
|
|
||||||
|
- 迁移前备份数据库
|
||||||
|
- 测试迁移在开发环境的执行
|
||||||
|
- 生产环境使用 `migrate deploy` 而不是 `migrate dev`
|
||||||
|
- 不要手动修改已应用的迁移文件
|
||||||
|
|
||||||
|
## 性能优化清单
|
||||||
|
|
||||||
|
- [ ] 频繁查询的字段添加了索引
|
||||||
|
- [ ] 使用 `include` 预加载关联数据
|
||||||
|
- [ ] 使用 `select` 只查询需要的字段
|
||||||
|
- [ ] 实现了分页查询
|
||||||
|
- [ ] 复杂操作使用了事务
|
||||||
|
- [ ] 避免了 N+1 查询问题
|
||||||
348
.cursor/rules/frontend-architecture.mdc
Normal file
348
.cursor/rules/frontend-architecture.mdc
Normal file
@ -0,0 +1,348 @@
|
|||||||
|
---
|
||||||
|
description: Vue 3 前端架构规范和组件开发
|
||||||
|
globs:
|
||||||
|
- "frontend/**/*.vue"
|
||||||
|
- "frontend/**/*.ts"
|
||||||
|
alwaysApply: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# 前端架构规范
|
||||||
|
|
||||||
|
## 组件结构
|
||||||
|
|
||||||
|
### 目录组织
|
||||||
|
|
||||||
|
- 页面组件放在 `views/` 目录下,按模块组织
|
||||||
|
- 公共组件放在 `components/` 目录下
|
||||||
|
- 组件命名使用 PascalCase
|
||||||
|
|
||||||
|
### 组件语法
|
||||||
|
|
||||||
|
使用 Vue 3 Composition API 的 `<script setup lang="ts">` 语法:
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<script setup lang="ts">
|
||||||
|
import { ref, computed, onMounted } from "vue";
|
||||||
|
import { message } from "ant-design-vue";
|
||||||
|
import { getUsers, type User } from "@/api/users";
|
||||||
|
|
||||||
|
const loading = ref(false);
|
||||||
|
const users = ref<User[]>([]);
|
||||||
|
|
||||||
|
const activeUsers = computed(() =>
|
||||||
|
users.value.filter((u) => u.validState === 1)
|
||||||
|
);
|
||||||
|
|
||||||
|
onMounted(async () => {
|
||||||
|
await fetchUsers();
|
||||||
|
});
|
||||||
|
|
||||||
|
const fetchUsers = async () => {
|
||||||
|
try {
|
||||||
|
loading.value = true;
|
||||||
|
users.value = await getUsers();
|
||||||
|
} catch (error) {
|
||||||
|
message.error("获取用户列表失败");
|
||||||
|
} finally {
|
||||||
|
loading.value = false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="p-4">
|
||||||
|
<a-spin :spinning="loading">
|
||||||
|
<a-table :dataSource="activeUsers" />
|
||||||
|
</a-spin>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
## API 调用规范
|
||||||
|
|
||||||
|
### 目录结构
|
||||||
|
|
||||||
|
所有 API 调用放在 `api/` 目录下,按模块组织:
|
||||||
|
|
||||||
|
```
|
||||||
|
api/
|
||||||
|
├── users.ts
|
||||||
|
├── roles.ts
|
||||||
|
├── contests.ts
|
||||||
|
└── auth.ts
|
||||||
|
```
|
||||||
|
|
||||||
|
### API 函数命名
|
||||||
|
|
||||||
|
- `getXxx` - 获取数据
|
||||||
|
- `createXxx` - 创建数据
|
||||||
|
- `updateXxx` - 更新数据
|
||||||
|
- `deleteXxx` - 删除数据
|
||||||
|
|
||||||
|
### 示例
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// api/users.ts
|
||||||
|
import request from "@/utils/request";
|
||||||
|
|
||||||
|
export interface User {
|
||||||
|
id: number;
|
||||||
|
username: string;
|
||||||
|
nickname: string;
|
||||||
|
email?: string;
|
||||||
|
validState: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CreateUserDto {
|
||||||
|
username: string;
|
||||||
|
password: string;
|
||||||
|
nickname: string;
|
||||||
|
email?: string;
|
||||||
|
roleIds?: number[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export const getUsers = (params?: { skip?: number; take?: number }) => {
|
||||||
|
return request.get<User[]>("/users", { params });
|
||||||
|
};
|
||||||
|
|
||||||
|
export const createUser = (data: CreateUserDto) => {
|
||||||
|
return request.post<User>("/users", data);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const updateUser = (id: number, data: Partial<CreateUserDto>) => {
|
||||||
|
return request.put<User>(`/users/${id}`, data);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const deleteUser = (id: number) => {
|
||||||
|
return request.delete(`/users/${id}`);
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 状态管理 (Pinia)
|
||||||
|
|
||||||
|
### Store 规范
|
||||||
|
|
||||||
|
- Store 文件放在 `stores/` 目录下
|
||||||
|
- 使用 `defineStore()` 定义 store
|
||||||
|
- Store 命名使用 camelCase + Store 后缀
|
||||||
|
|
||||||
|
### 示例
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// stores/auth.ts
|
||||||
|
import { defineStore } from "pinia";
|
||||||
|
import { ref, computed } from "vue";
|
||||||
|
import { login, getUserInfo, type LoginDto, type User } from "@/api/auth";
|
||||||
|
|
||||||
|
export const useAuthStore = defineStore("auth", () => {
|
||||||
|
const token = ref<string | null>(localStorage.getItem("token"));
|
||||||
|
const user = ref<User | null>(null);
|
||||||
|
const menus = ref<any[]>([]);
|
||||||
|
|
||||||
|
const isAuthenticated = computed(() => !!token.value && !!user.value);
|
||||||
|
|
||||||
|
const loginAction = async (loginDto: LoginDto) => {
|
||||||
|
const {
|
||||||
|
accessToken,
|
||||||
|
user: userInfo,
|
||||||
|
menus: userMenus,
|
||||||
|
} = await login(loginDto);
|
||||||
|
token.value = accessToken;
|
||||||
|
user.value = userInfo;
|
||||||
|
menus.value = userMenus;
|
||||||
|
localStorage.setItem("token", accessToken);
|
||||||
|
};
|
||||||
|
|
||||||
|
const logout = () => {
|
||||||
|
token.value = null;
|
||||||
|
user.value = null;
|
||||||
|
menus.value = [];
|
||||||
|
localStorage.removeItem("token");
|
||||||
|
};
|
||||||
|
|
||||||
|
return {
|
||||||
|
token,
|
||||||
|
user,
|
||||||
|
menus,
|
||||||
|
isAuthenticated,
|
||||||
|
loginAction,
|
||||||
|
logout,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## 路由管理
|
||||||
|
|
||||||
|
### 路由规范
|
||||||
|
|
||||||
|
- 路由配置在 `router/index.ts`
|
||||||
|
- 支持动态路由(基于菜单权限)
|
||||||
|
- 路由路径包含租户编码:`/:tenantCode/xxx`
|
||||||
|
- 路由 meta 包含权限信息
|
||||||
|
|
||||||
|
### 示例
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
{
|
||||||
|
path: '/:tenantCode/users',
|
||||||
|
name: 'Users',
|
||||||
|
component: () => import('@/views/users/Index.vue'),
|
||||||
|
meta: {
|
||||||
|
requiresAuth: true,
|
||||||
|
permissions: ['user:read'],
|
||||||
|
roles: ['admin'],
|
||||||
|
},
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 表单验证
|
||||||
|
|
||||||
|
### 使用 VeeValidate + Zod
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<script setup lang="ts">
|
||||||
|
import { useForm } from "vee-validate";
|
||||||
|
import { toTypedSchema } from "@vee-validate/zod";
|
||||||
|
import * as z from "zod";
|
||||||
|
|
||||||
|
const schema = z.object({
|
||||||
|
username: z.string().min(3, "用户名至少3个字符"),
|
||||||
|
password: z.string().min(6, "密码至少6个字符"),
|
||||||
|
email: z.string().email("邮箱格式不正确").optional(),
|
||||||
|
});
|
||||||
|
|
||||||
|
const { defineField, handleSubmit, errors } = useForm({
|
||||||
|
validationSchema: toTypedSchema(schema),
|
||||||
|
});
|
||||||
|
|
||||||
|
const [username] = defineField("username");
|
||||||
|
const [password] = defineField("password");
|
||||||
|
const [email] = defineField("email");
|
||||||
|
|
||||||
|
const onSubmit = handleSubmit(async (values) => {
|
||||||
|
try {
|
||||||
|
await createUser(values);
|
||||||
|
message.success("创建成功");
|
||||||
|
} catch (error) {
|
||||||
|
message.error("创建失败");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<a-form @submit.prevent="onSubmit">
|
||||||
|
<a-form-item
|
||||||
|
:help="errors.username"
|
||||||
|
:validateStatus="errors.username ? 'error' : ''"
|
||||||
|
>
|
||||||
|
<a-input v-model:value="username" placeholder="用户名" />
|
||||||
|
</a-form-item>
|
||||||
|
<a-form-item
|
||||||
|
:help="errors.password"
|
||||||
|
:validateStatus="errors.password ? 'error' : ''"
|
||||||
|
>
|
||||||
|
<a-input-password v-model:value="password" placeholder="密码" />
|
||||||
|
</a-form-item>
|
||||||
|
<a-button type="primary" html-type="submit">提交</a-button>
|
||||||
|
</a-form>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
## UI 组件规范
|
||||||
|
|
||||||
|
### Ant Design Vue
|
||||||
|
|
||||||
|
- 使用 Ant Design Vue 组件库
|
||||||
|
- 遵循 Ant Design 设计规范
|
||||||
|
|
||||||
|
### 样式
|
||||||
|
|
||||||
|
- 使用 Tailwind CSS 工具类
|
||||||
|
- 复杂样式使用 SCSS
|
||||||
|
- 响应式设计,移动端优先
|
||||||
|
|
||||||
|
### 状态管理
|
||||||
|
|
||||||
|
组件必须有 loading 和 error 状态:
|
||||||
|
|
||||||
|
```vue
|
||||||
|
<template>
|
||||||
|
<div class="p-4">
|
||||||
|
<a-spin :spinning="loading">
|
||||||
|
<a-alert
|
||||||
|
v-if="error"
|
||||||
|
type="error"
|
||||||
|
:message="error"
|
||||||
|
closable
|
||||||
|
@close="error = null"
|
||||||
|
/>
|
||||||
|
<div v-else>
|
||||||
|
<!-- 内容 -->
|
||||||
|
</div>
|
||||||
|
</a-spin>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
## TypeScript 类型定义
|
||||||
|
|
||||||
|
### 类型文件组织
|
||||||
|
|
||||||
|
- TypeScript 类型定义放在 `types/` 目录下
|
||||||
|
- 接口类型使用 `interface`
|
||||||
|
- 数据模型使用 `type`
|
||||||
|
- 导出类型供其他模块使用
|
||||||
|
|
||||||
|
### 示例
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// types/user.ts
|
||||||
|
export interface User {
|
||||||
|
id: number;
|
||||||
|
username: string;
|
||||||
|
nickname: string;
|
||||||
|
email?: string;
|
||||||
|
tenantId: number;
|
||||||
|
validState: number;
|
||||||
|
createTime: string;
|
||||||
|
modifyTime: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type CreateUserParams = Omit<
|
||||||
|
User,
|
||||||
|
"id" | "tenantId" | "createTime" | "modifyTime"
|
||||||
|
>;
|
||||||
|
|
||||||
|
export type UserRole = {
|
||||||
|
userId: number;
|
||||||
|
roleId: number;
|
||||||
|
role: Role;
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 性能优化
|
||||||
|
|
||||||
|
### 路由懒加载
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const routes = [
|
||||||
|
{
|
||||||
|
path: "/users",
|
||||||
|
component: () => import("@/views/users/Index.vue"),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
```
|
||||||
|
|
||||||
|
### 组件按需加载
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { defineAsyncComponent } from "vue";
|
||||||
|
|
||||||
|
const AsyncComponent = defineAsyncComponent(
|
||||||
|
() => import("@/components/HeavyComponent.vue")
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
### 避免不必要的重新渲染
|
||||||
|
|
||||||
|
使用 `computed`、`watchEffect` 和 `memo` 优化性能。
|
||||||
101
.cursor/rules/multi-tenant.mdc
Normal file
101
.cursor/rules/multi-tenant.mdc
Normal file
@ -0,0 +1,101 @@
|
|||||||
|
---
|
||||||
|
description: 多租户数据隔离规范(所有涉及数据库操作的代码必须遵守)
|
||||||
|
globs:
|
||||||
|
alwaysApply: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# 多租户处理规范
|
||||||
|
|
||||||
|
⚠️ **极其重要**:所有业务数据查询必须包含 `tenantId` 条件!
|
||||||
|
|
||||||
|
## 核心原则
|
||||||
|
|
||||||
|
### 1. 数据库查询
|
||||||
|
|
||||||
|
- **必须**:所有业务表查询必须包含 `tenantId` 条件
|
||||||
|
- 超级租户(`isSuper = 1`)可以访问所有租户数据
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ 正确示例
|
||||||
|
const users = await this.prisma.user.findMany({
|
||||||
|
where: {
|
||||||
|
tenantId,
|
||||||
|
validState: 1,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// ❌ 错误示例 - 缺少 tenantId
|
||||||
|
const users = await this.prisma.user.findMany({
|
||||||
|
where: {
|
||||||
|
validState: 1,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. 获取租户ID
|
||||||
|
|
||||||
|
在控制器中使用 `@CurrentTenantId()` 装饰器:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
@Get()
|
||||||
|
async findAll(@CurrentTenantId() tenantId: number) {
|
||||||
|
return this.service.findAll(tenantId);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. 创建数据
|
||||||
|
|
||||||
|
创建数据时自动设置 `tenantId`:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
async create(createDto: CreateDto, tenantId: number) {
|
||||||
|
return this.prisma.model.create({
|
||||||
|
data: {
|
||||||
|
...createDto,
|
||||||
|
tenantId,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. 更新/删除数据
|
||||||
|
|
||||||
|
更新或删除前验证数据属于当前租户:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
async update(id: number, updateDto: UpdateDto, tenantId: number) {
|
||||||
|
// 先验证数据属于当前租户
|
||||||
|
const existing = await this.prisma.model.findFirst({
|
||||||
|
where: { id, tenantId },
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!existing) {
|
||||||
|
throw new NotFoundException('数据不存在或不属于当前租户');
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.prisma.model.update({
|
||||||
|
where: { id },
|
||||||
|
data: updateDto,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 数据库表设计
|
||||||
|
|
||||||
|
所有业务表必须包含:
|
||||||
|
|
||||||
|
- `tenantId`: Int - 租户ID(必填)
|
||||||
|
- `creator`: Int? - 创建人ID
|
||||||
|
- `modifier`: Int? - 修改人ID
|
||||||
|
- `createTime`: DateTime @default(now())
|
||||||
|
- `modifyTime`: DateTime @updatedAt
|
||||||
|
- `validState`: Int @default(1) - 有效状态(1-有效,2-失效)
|
||||||
|
|
||||||
|
## 审查清单
|
||||||
|
|
||||||
|
在代码审查时,重点检查:
|
||||||
|
|
||||||
|
- [ ] 所有 `findMany`、`findFirst`、`findUnique` 包含 `tenantId` 条件
|
||||||
|
- [ ] 创建操作设置了 `tenantId`
|
||||||
|
- [ ] 更新/删除操作验证了 `tenantId`
|
||||||
|
- [ ] 新的 Prisma 模型包含了 `tenantId` 字段
|
||||||
41
.cursor/rules/project-overview.mdc
Normal file
41
.cursor/rules/project-overview.mdc
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
---
|
||||||
|
description: 项目概述和技术栈信息
|
||||||
|
globs:
|
||||||
|
alwaysApply: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# 项目概述
|
||||||
|
|
||||||
|
这是一个多租户的竞赛管理系统,采用前后端分离架构。
|
||||||
|
|
||||||
|
## 技术栈
|
||||||
|
|
||||||
|
### 后端
|
||||||
|
|
||||||
|
- **框架**: NestJS + TypeScript
|
||||||
|
- **数据库**: MySQL 8.0
|
||||||
|
- **ORM**: Prisma
|
||||||
|
- **认证**: JWT + RBAC (基于角色的访问控制)
|
||||||
|
|
||||||
|
### 前端
|
||||||
|
|
||||||
|
- **框架**: Vue 3 + TypeScript
|
||||||
|
- **构建工具**: Vite
|
||||||
|
- **UI 组件库**: Ant Design Vue
|
||||||
|
- **状态管理**: Pinia
|
||||||
|
- **路由**: Vue Router 4
|
||||||
|
- **表单验证**: VeeValidate + Zod
|
||||||
|
|
||||||
|
## 核心特性
|
||||||
|
|
||||||
|
- **多租户架构**: 数据完全隔离,每个租户使用独立的 tenantId
|
||||||
|
- **RBAC 权限系统**: 基于角色的细粒度权限控制
|
||||||
|
- **动态菜单系统**: 基于权限的动态路由和菜单
|
||||||
|
- **审计日志**: 完整的操作审计追踪
|
||||||
|
|
||||||
|
## 代码风格
|
||||||
|
|
||||||
|
- 使用 TypeScript 严格模式
|
||||||
|
- 使用 ESLint 和 Prettier 格式化代码
|
||||||
|
- 注释使用中文
|
||||||
|
- Git 提交信息使用中文,格式:`类型: 描述`
|
||||||
14
.cursor/scripts/chrome-devtools-mcp.sh
Executable file
14
.cursor/scripts/chrome-devtools-mcp.sh
Executable file
@ -0,0 +1,14 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# Chrome DevTools MCP wrapper script
|
||||||
|
# Ensures correct Node.js version is used
|
||||||
|
|
||||||
|
# Load nvm if available
|
||||||
|
export NVM_DIR="$HOME/.nvm"
|
||||||
|
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
|
||||||
|
|
||||||
|
# Use Node.js 20.19.0 (or default)
|
||||||
|
nvm use default 2>/dev/null || nvm use 20.19.0 2>/dev/null || true
|
||||||
|
|
||||||
|
# Run chrome-devtools-mcp
|
||||||
|
exec node "/Users/wwzh/Library/pnpm/global/5/.pnpm/chrome-devtools-mcp@0.10.2/node_modules/chrome-devtools-mcp/build/src/index.js" "$@"
|
||||||
|
|
||||||
100
.cursorignore
Normal file
100
.cursorignore
Normal file
@ -0,0 +1,100 @@
|
|||||||
|
# Dependencies
|
||||||
|
node_modules/
|
||||||
|
*/node_modules/
|
||||||
|
.pnpm-store/
|
||||||
|
|
||||||
|
# Build outputs
|
||||||
|
dist/
|
||||||
|
*/dist/
|
||||||
|
build/
|
||||||
|
*/build/
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# Environment variables (may contain sensitive information)
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.*.local
|
||||||
|
*/.env
|
||||||
|
*/.env.local
|
||||||
|
*/.env.*.local
|
||||||
|
|
||||||
|
# Logs
|
||||||
|
logs/
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
# Testing coverage (keep test files for context)
|
||||||
|
coverage/
|
||||||
|
.nyc_output/
|
||||||
|
|
||||||
|
# Database files
|
||||||
|
*.db
|
||||||
|
*.sqlite
|
||||||
|
*.sqlite3
|
||||||
|
|
||||||
|
# Lock files (too large and not needed for context)
|
||||||
|
pnpm-lock.yaml
|
||||||
|
package-lock.json
|
||||||
|
yarn.lock
|
||||||
|
|
||||||
|
# IDE
|
||||||
|
.vscode/
|
||||||
|
.idea/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*~
|
||||||
|
|
||||||
|
# OS
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
|
*.tmp
|
||||||
|
|
||||||
|
# Prisma migrations SQL files (generated, but may be useful for context)
|
||||||
|
# Uncomment if you want to ignore migration SQL files:
|
||||||
|
# backend/prisma/migrations/**/*.sql
|
||||||
|
|
||||||
|
# Compiled JavaScript files (keep TypeScript source and config files)
|
||||||
|
*.js
|
||||||
|
*.js.map
|
||||||
|
*.d.ts
|
||||||
|
!*.config.js
|
||||||
|
!*.config.ts
|
||||||
|
!vite.config.js
|
||||||
|
!tailwind.config.js
|
||||||
|
!postcss.config.js
|
||||||
|
|
||||||
|
# Frontend build artifacts
|
||||||
|
frontend/dist/
|
||||||
|
frontend/dist-ssr/
|
||||||
|
frontend/.vite/
|
||||||
|
|
||||||
|
# Backend build artifacts
|
||||||
|
backend/dist/
|
||||||
|
|
||||||
|
# Large binary files
|
||||||
|
*.zip
|
||||||
|
*.tar.gz
|
||||||
|
*.rar
|
||||||
|
*.7z
|
||||||
|
|
||||||
|
# Documentation build outputs (if any)
|
||||||
|
docs/_build/
|
||||||
|
docs/.vuepress/dist/
|
||||||
|
|
||||||
|
# Cache directories
|
||||||
|
.cache/
|
||||||
|
.parcel-cache/
|
||||||
|
.next/
|
||||||
|
.nuxt/
|
||||||
|
.vuepress/dist/
|
||||||
|
|
||||||
|
# Temporary files
|
||||||
|
tmp/
|
||||||
|
temp/
|
||||||
|
*.tmp
|
||||||
|
*.temp
|
||||||
|
|
||||||
293
.cursorrules
Normal file
293
.cursorrules
Normal file
@ -0,0 +1,293 @@
|
|||||||
|
# Competition Management System - Cursor User Rules (DEPRECATED)
|
||||||
|
|
||||||
|
⚠️ **此文件已废弃** - 请使用新的规则系统:
|
||||||
|
- 项目规则:`.cursor/rules/*.mdc`
|
||||||
|
- 快速参考:`AGENTS.md`
|
||||||
|
- 说明文档:`.cursor/RULES_README.md`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
以下内容保留作为备份,但不再使用:
|
||||||
|
|
||||||
|
# Competition Management System - Cursor User Rules
|
||||||
|
|
||||||
|
## 项目概述
|
||||||
|
|
||||||
|
这是一个多租户的竞赛管理系统,采用前后端分离架构:
|
||||||
|
- **后端**: NestJS + TypeScript + Prisma + MySQL
|
||||||
|
- **前端**: Vue 3 + TypeScript + Vite + Ant Design Vue + Pinia
|
||||||
|
- **认证**: JWT + RBAC (基于角色的访问控制)
|
||||||
|
- **架构**: 多租户架构,数据完全隔离
|
||||||
|
|
||||||
|
## 后端开发规范
|
||||||
|
|
||||||
|
### 1. 模块结构
|
||||||
|
|
||||||
|
- 每个功能模块应包含:`module.ts`, `controller.ts`, `service.ts`, `dto/` 目录
|
||||||
|
- 模块命名使用复数形式(如 `users`, `roles`, `contests`)
|
||||||
|
- 子模块放在父模块目录下(如 `contests/works/`, `contests/teams/`)
|
||||||
|
|
||||||
|
### 2. 服务层 (Service)
|
||||||
|
|
||||||
|
- 所有数据库操作必须通过 PrismaService,禁止直接使用 SQL
|
||||||
|
- 服务方法必须处理租户隔离:所有查询必须包含 `tenantId` 条件
|
||||||
|
- 使用 `@Injectable()` 装饰器
|
||||||
|
- 构造函数注入依赖,使用 private readonly
|
||||||
|
- 方法命名:`create`, `findAll`, `findOne`, `update`, `remove`
|
||||||
|
- 查询方法应支持分页:使用 `skip` 和 `take` 参数
|
||||||
|
|
||||||
|
### 3. 控制器层 (Controller)
|
||||||
|
|
||||||
|
- 使用 `@Controller()` 装饰器,路径使用复数形式
|
||||||
|
- 所有路由默认需要认证(除非使用 `@Public()` 装饰器)
|
||||||
|
- 使用 `@Get()`, `@Post()`, `@Put()`, `@Delete()`, `@Patch()` 装饰器
|
||||||
|
- 从请求中获取租户ID:使用 `@CurrentTenantId()` 装饰器或从 JWT token 中提取
|
||||||
|
- 使用 `@CurrentUser()` 装饰器获取当前用户信息
|
||||||
|
- 权限控制:使用 `@RequirePermission()` 装饰器
|
||||||
|
- 返回统一响应格式:使用 TransformInterceptor(自动处理)
|
||||||
|
|
||||||
|
### 4. DTO (Data Transfer Object)
|
||||||
|
|
||||||
|
- 所有 DTO 放在 `dto/` 目录下
|
||||||
|
- 使用 `class-validator` 进行验证
|
||||||
|
- 命名规范:
|
||||||
|
- 创建:`CreateXxxDto`
|
||||||
|
- 更新:`UpdateXxxDto`
|
||||||
|
- 查询:`QueryXxxDto`
|
||||||
|
- 必填字段使用验证装饰器(如 `@IsString()`, `@IsNumber()`)
|
||||||
|
- 可选字段使用 `@IsOptional()`
|
||||||
|
- 数组字段使用 `@IsArray()` 和 `@IsNumber({}, { each: true })`
|
||||||
|
|
||||||
|
### 5. 数据库操作 (Prisma)
|
||||||
|
|
||||||
|
- 所有表必须包含 `tenantId` 字段(租户隔离)
|
||||||
|
- 所有表必须包含审计字段:`creator`, `modifier`, `createTime`, `modifyTime`
|
||||||
|
- 使用 Prisma 的 `include` 和 `select` 优化查询
|
||||||
|
- 关联查询使用嵌套 include,避免 N+1 问题
|
||||||
|
- 删除操作使用软删除(`validState` 字段)或级联删除
|
||||||
|
- 事务操作使用 `prisma.$transaction()`
|
||||||
|
|
||||||
|
### 6. 多租户处理
|
||||||
|
|
||||||
|
- **必须**:所有业务数据查询必须包含 `tenantId` 条件
|
||||||
|
- 从 JWT token 或请求头中获取租户ID
|
||||||
|
- 创建数据时自动设置 `tenantId`
|
||||||
|
- 更新/删除时验证数据属于当前租户
|
||||||
|
- 超级租户(`isSuper = 1`)可以访问所有租户数据
|
||||||
|
|
||||||
|
### 7. 权限控制
|
||||||
|
|
||||||
|
- 使用 `@RequirePermission()` 装饰器进行权限检查
|
||||||
|
- 权限字符串格式:`模块:操作`(如 `contest:create`, `user:update`)
|
||||||
|
- 角色权限通过 RolesGuard 自动检查
|
||||||
|
- 权限验证失败返回 403 Forbidden
|
||||||
|
|
||||||
|
### 8. 错误处理
|
||||||
|
|
||||||
|
- 使用 NestJS 内置异常:`NotFoundException`, `BadRequestException`, `UnauthorizedException`, `ForbiddenException`
|
||||||
|
- 自定义异常消息使用中文
|
||||||
|
- 错误信息要清晰明确,便于调试
|
||||||
|
|
||||||
|
### 9. 代码风格
|
||||||
|
|
||||||
|
- 使用 TypeScript 严格模式
|
||||||
|
- 使用 ESLint 和 Prettier 格式化代码
|
||||||
|
- 导入顺序:NestJS 核心 → 第三方库 → 本地模块
|
||||||
|
- 使用 async/await,避免 Promise.then()
|
||||||
|
- 使用解构赋值提高代码可读性
|
||||||
|
|
||||||
|
## 前端开发规范
|
||||||
|
|
||||||
|
### 1. 组件结构
|
||||||
|
|
||||||
|
- 页面组件放在 `views/` 目录下,按模块组织
|
||||||
|
- 公共组件放在 `components/` 目录下
|
||||||
|
- 使用 `<script setup lang="ts">` 语法
|
||||||
|
- 组件命名使用 PascalCase
|
||||||
|
|
||||||
|
### 2. API 调用
|
||||||
|
|
||||||
|
- 所有 API 调用放在 `api/` 目录下,按模块组织
|
||||||
|
- 使用 axios 实例(已配置拦截器)
|
||||||
|
- API 函数命名:`getXxx`, `createXxx`, `updateXxx`, `deleteXxx`
|
||||||
|
- 使用 TypeScript 类型定义请求和响应
|
||||||
|
|
||||||
|
### 3. 状态管理 (Pinia)
|
||||||
|
|
||||||
|
- Store 文件放在 `stores/` 目录下
|
||||||
|
- 使用 `defineStore()` 定义 store
|
||||||
|
- Store 命名使用 camelCase + Store 后缀(如 `authStore`)
|
||||||
|
|
||||||
|
### 4. 路由管理
|
||||||
|
|
||||||
|
- 路由配置在 `router/index.ts`
|
||||||
|
- 支持动态路由(基于菜单权限)
|
||||||
|
- 路由路径包含租户编码:`/:tenantCode/xxx`
|
||||||
|
- 路由 meta 包含权限信息:`permissions`, `roles`
|
||||||
|
|
||||||
|
### 5. 表单验证
|
||||||
|
|
||||||
|
- 使用 VeeValidate + Zod 进行表单验证
|
||||||
|
- 验证规则定义在组件内或单独的 schema 文件
|
||||||
|
- 错误提示使用中文
|
||||||
|
|
||||||
|
### 6. UI 组件
|
||||||
|
|
||||||
|
- 使用 Ant Design Vue 组件库
|
||||||
|
- 样式使用 Tailwind CSS + SCSS
|
||||||
|
- 响应式设计:移动端优先
|
||||||
|
- 组件要有 loading 和 error 状态
|
||||||
|
|
||||||
|
### 7. 类型定义
|
||||||
|
|
||||||
|
- TypeScript 类型定义放在 `types/` 目录下
|
||||||
|
- 接口类型使用 `interface`,数据模型使用 `type`
|
||||||
|
- 导出类型供其他模块使用
|
||||||
|
|
||||||
|
## 数据库设计规范
|
||||||
|
|
||||||
|
### 1. 表结构
|
||||||
|
|
||||||
|
- 所有业务表必须包含 `tenantId` 字段
|
||||||
|
- 所有表必须包含审计字段:
|
||||||
|
- `creator`: Int? - 创建人ID
|
||||||
|
- `modifier`: Int? - 修改人ID
|
||||||
|
- `createTime`: DateTime @default(now()) - 创建时间
|
||||||
|
- `modifyTime`: DateTime @updatedAt - 修改时间
|
||||||
|
- 状态字段使用 `validState`: Int @default(1)(1-有效,2-失效)
|
||||||
|
- 表名使用复数形式,映射使用 `@@map("table_name")`
|
||||||
|
|
||||||
|
### 2. 关系设计
|
||||||
|
|
||||||
|
- 使用 Prisma 关系定义外键
|
||||||
|
- 级联删除:`onDelete: Cascade`
|
||||||
|
- 可选关联:`onDelete: SetNull`
|
||||||
|
- 一对一关系:使用 `?` 标记可选
|
||||||
|
|
||||||
|
### 3. 索引
|
||||||
|
|
||||||
|
- 主键自动索引
|
||||||
|
- 外键字段自动索引
|
||||||
|
- 查询频繁的字段添加索引
|
||||||
|
- 唯一约束使用 `@unique`
|
||||||
|
|
||||||
|
### 4. 迁移
|
||||||
|
|
||||||
|
- 使用 Prisma Migrate 管理数据库迁移
|
||||||
|
- 迁移文件命名:`YYYYMMDDHHMMSS_description`
|
||||||
|
- 迁移前备份数据库
|
||||||
|
- 生产环境使用 `prisma migrate deploy`
|
||||||
|
|
||||||
|
## 通用开发规范
|
||||||
|
|
||||||
|
### 1. Git 提交
|
||||||
|
|
||||||
|
- 提交信息使用中文
|
||||||
|
- 格式:`类型: 描述`(如 `feat: 添加竞赛管理功能`)
|
||||||
|
- 类型:`feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
|
||||||
|
|
||||||
|
### 2. 注释
|
||||||
|
|
||||||
|
- 复杂逻辑必须添加注释
|
||||||
|
- 函数注释说明参数和返回值
|
||||||
|
- 使用中文注释
|
||||||
|
|
||||||
|
### 3. 测试
|
||||||
|
|
||||||
|
- 单元测试文件命名:`*.spec.ts`
|
||||||
|
- 测试覆盖率要求:核心业务逻辑 > 80%
|
||||||
|
- 使用 Jest 进行测试
|
||||||
|
|
||||||
|
### 4. 环境配置
|
||||||
|
|
||||||
|
- 使用 `.env.development` 和 `.env.production`
|
||||||
|
- 敏感信息不要提交到 Git
|
||||||
|
- 配置项通过 `@nestjs/config` 管理
|
||||||
|
|
||||||
|
### 5. 日志
|
||||||
|
|
||||||
|
- 使用 NestJS Logger
|
||||||
|
- 日志级别:`error`, `warn`, `log`, `debug`, `verbose`
|
||||||
|
- 记录关键操作和错误信息
|
||||||
|
|
||||||
|
## 安全规范
|
||||||
|
|
||||||
|
### 1. 认证授权
|
||||||
|
|
||||||
|
- 所有 API 默认需要 JWT 认证
|
||||||
|
- 密码使用 bcrypt 加密(salt rounds: 10)
|
||||||
|
- Token 过期时间合理设置
|
||||||
|
- 敏感操作需要额外验证
|
||||||
|
|
||||||
|
### 2. 数据验证
|
||||||
|
|
||||||
|
- 前端和后端都要进行数据验证
|
||||||
|
- 使用 DTO 和 class-validator 验证输入
|
||||||
|
- 防止 SQL 注入:使用 Prisma(参数化查询)
|
||||||
|
- 防止 XSS:前端转义用户输入
|
||||||
|
|
||||||
|
### 3. 权限控制
|
||||||
|
|
||||||
|
- 最小权限原则
|
||||||
|
- 前端显示控制 + 后端权限验证
|
||||||
|
- 租户数据隔离必须严格检查
|
||||||
|
|
||||||
|
## 性能优化
|
||||||
|
|
||||||
|
### 1. 数据库查询
|
||||||
|
|
||||||
|
- 避免 N+1 查询,使用 `include` 预加载
|
||||||
|
- 使用 `select` 只查询需要的字段
|
||||||
|
- 分页查询必须实现
|
||||||
|
- 大表查询添加索引
|
||||||
|
|
||||||
|
### 2. API 响应
|
||||||
|
|
||||||
|
- 响应数据精简,避免返回不必要字段
|
||||||
|
- 使用分页减少单次数据量
|
||||||
|
- 长时间操作使用异步处理
|
||||||
|
|
||||||
|
### 3. 前端优化
|
||||||
|
|
||||||
|
- 路由懒加载
|
||||||
|
- 组件按需加载
|
||||||
|
- 图片使用 CDN 或压缩
|
||||||
|
- 避免不必要的重新渲染
|
||||||
|
|
||||||
|
## 代码审查检查清单
|
||||||
|
|
||||||
|
- [ ] 所有数据库查询包含 `tenantId` 条件
|
||||||
|
- [ ] DTO 验证规则完整
|
||||||
|
- [ ] 错误处理完善
|
||||||
|
- [ ] 权限检查正确
|
||||||
|
- [ ] 代码格式符合规范
|
||||||
|
- [ ] 注释清晰
|
||||||
|
- [ ] 无硬编码配置
|
||||||
|
- [ ] 类型定义完整
|
||||||
|
- [ ] 无控制台日志(生产环境)
|
||||||
|
|
||||||
|
## 常见问题
|
||||||
|
|
||||||
|
### Q: 如何获取当前租户ID?
|
||||||
|
A: 在控制器中使用 `@CurrentTenantId()` 装饰器,或在服务中从 JWT token 提取。
|
||||||
|
|
||||||
|
### Q: 如何创建新的业务模块?
|
||||||
|
A:
|
||||||
|
1. 在 Prisma schema 中定义模型
|
||||||
|
2. 运行 `prisma migrate dev`
|
||||||
|
3. 创建模块目录和文件(module, controller, service, dto)
|
||||||
|
4. 在 `app.module.ts` 中注册模块
|
||||||
|
5. 创建前端 API 和页面
|
||||||
|
|
||||||
|
### Q: 如何处理多租户数据隔离?
|
||||||
|
A:
|
||||||
|
- 查询时始终包含 `where: { tenantId }`
|
||||||
|
- 创建时自动设置 `tenantId`
|
||||||
|
- 更新/删除前验证数据属于当前租户
|
||||||
|
|
||||||
|
### Q: 如何添加新的权限?
|
||||||
|
A:
|
||||||
|
1. 在数据库中创建权限记录
|
||||||
|
2. 在路由或控制器方法上使用 `@RequirePermission('module:action')`
|
||||||
|
3. 在前端路由 meta 中添加 `permissions` 字段
|
||||||
|
|
||||||
48
.gitignore
vendored
Normal file
48
.gitignore
vendored
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
# Dependencies
|
||||||
|
node_modules/
|
||||||
|
*/node_modules/
|
||||||
|
.pnpm-store/
|
||||||
|
|
||||||
|
# Build outputs
|
||||||
|
dist/
|
||||||
|
*/dist/
|
||||||
|
build/
|
||||||
|
*/build/
|
||||||
|
|
||||||
|
# pnpm
|
||||||
|
.pnpm-debug.log*
|
||||||
|
|
||||||
|
# Environment variables
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.*.local
|
||||||
|
*/.env
|
||||||
|
*/.env.local
|
||||||
|
|
||||||
|
# IDE
|
||||||
|
.vscode/
|
||||||
|
.idea/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*~
|
||||||
|
|
||||||
|
# OS
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
|
|
||||||
|
# Logs
|
||||||
|
/logs/
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
|
||||||
|
# Testing
|
||||||
|
coverage/
|
||||||
|
.nyc_output/
|
||||||
|
|
||||||
|
# Prisma
|
||||||
|
backend/prisma/migrations/
|
||||||
|
|
||||||
|
tmpclaude-*
|
||||||
|
.claude/worktrees/
|
||||||
8
.npmrc
Normal file
8
.npmrc
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# pnpm 配置
|
||||||
|
shamefully-hoist=true
|
||||||
|
strict-peer-dependencies=false
|
||||||
|
auto-install-peers=true
|
||||||
|
|
||||||
|
# 使用国内镜像(可选,根据需要取消注释)
|
||||||
|
# registry=https://registry.npmmirror.com
|
||||||
|
|
||||||
128
AGENTS.md
Normal file
128
AGENTS.md
Normal file
@ -0,0 +1,128 @@
|
|||||||
|
# Competition Management System - Agent Instructions
|
||||||
|
|
||||||
|
这是一个多租户的竞赛管理系统,采用 NestJS + Vue 3 技术栈。
|
||||||
|
|
||||||
|
## 🚨 最重要的规则
|
||||||
|
|
||||||
|
### 多租户数据隔离
|
||||||
|
|
||||||
|
**所有数据库查询必须包含 `tenantId` 条件!** 这是系统安全的核心。
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ 正确
|
||||||
|
const users = await prisma.user.findMany({
|
||||||
|
where: { tenantId, validState: 1 }
|
||||||
|
});
|
||||||
|
|
||||||
|
// ❌ 错误 - 绝对不允许
|
||||||
|
const users = await prisma.user.findMany();
|
||||||
|
```
|
||||||
|
|
||||||
|
## 后端开发
|
||||||
|
|
||||||
|
### 模块结构
|
||||||
|
- 使用 NestJS 标准模块结构:module、controller、service、dto
|
||||||
|
- 所有数据操作通过 Prisma,禁止直接 SQL
|
||||||
|
- 使用 `@Injectable()`、`@Controller()` 装饰器
|
||||||
|
|
||||||
|
### 权限控制
|
||||||
|
- 使用 `@RequirePermission('module:action')` 装饰器
|
||||||
|
- 格式:`user:create`、`contest:update`、`role:delete`
|
||||||
|
- 所有路由默认需要认证,公开接口使用 `@Public()`
|
||||||
|
|
||||||
|
### DTO 验证
|
||||||
|
```typescript
|
||||||
|
export class CreateUserDto {
|
||||||
|
@IsString()
|
||||||
|
username: string;
|
||||||
|
|
||||||
|
@IsEmail()
|
||||||
|
@IsOptional()
|
||||||
|
email?: string;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 错误处理
|
||||||
|
- 使用 NestJS 内置异常,消息用中文
|
||||||
|
- `NotFoundException`、`BadRequestException`、`ForbiddenException`
|
||||||
|
|
||||||
|
## 前端开发
|
||||||
|
|
||||||
|
### 组件开发
|
||||||
|
- 使用 Vue 3 `<script setup lang="ts">` 语法
|
||||||
|
- 页面组件放在 `views/` 目录,按模块组织
|
||||||
|
- 使用 Ant Design Vue 组件库
|
||||||
|
|
||||||
|
### API 调用
|
||||||
|
- API 文件放在 `api/` 目录,按模块组织
|
||||||
|
- 函数命名:`getXxx`、`createXxx`、`updateXxx`、`deleteXxx`
|
||||||
|
- 使用 TypeScript 类型定义
|
||||||
|
|
||||||
|
### 路由
|
||||||
|
- 路由路径必须包含租户编码:`/:tenantCode/users`
|
||||||
|
- 使用动态路由(基于菜单权限)
|
||||||
|
|
||||||
|
### 状态管理
|
||||||
|
- 使用 Pinia,store 命名:`useAuthStore`、`useUserStore`
|
||||||
|
|
||||||
|
## 数据库设计
|
||||||
|
|
||||||
|
### 必需字段
|
||||||
|
所有业务表必须包含:
|
||||||
|
```prisma
|
||||||
|
model YourModel {
|
||||||
|
id Int @id @default(autoincrement())
|
||||||
|
tenantId Int @map("tenant_id")
|
||||||
|
validState Int @default(1) @map("valid_state")
|
||||||
|
creator Int?
|
||||||
|
modifier Int?
|
||||||
|
createTime DateTime @default(now()) @map("create_time")
|
||||||
|
modifyTime DateTime @updatedAt @map("modify_time")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 性能优化
|
||||||
|
- 使用 `include` 预加载,避免 N+1 查询
|
||||||
|
- 使用 `select` 精简字段
|
||||||
|
- 实现分页查询
|
||||||
|
|
||||||
|
## 代码风格
|
||||||
|
|
||||||
|
- TypeScript 严格模式
|
||||||
|
- 使用 async/await,避免 Promise.then()
|
||||||
|
- 使用中文注释
|
||||||
|
- Git 提交信息:`类型: 描述`(如 `feat: 添加用户管理`)
|
||||||
|
|
||||||
|
## 快速参考
|
||||||
|
|
||||||
|
### 创建新模块
|
||||||
|
1. 在 Prisma schema 定义模型
|
||||||
|
2. 运行 `pnpm prisma:migrate:dev`
|
||||||
|
3. 创建 NestJS 模块(module、controller、service、dto)
|
||||||
|
4. 在 `app.module.ts` 注册
|
||||||
|
5. 创建前端 API 和页面
|
||||||
|
|
||||||
|
### 常用装饰器
|
||||||
|
- `@CurrentTenantId()` - 获取租户ID
|
||||||
|
- `@CurrentUser()` - 获取当前用户
|
||||||
|
- `@RequirePermission()` - 权限检查
|
||||||
|
- `@Public()` - 公开接口
|
||||||
|
|
||||||
|
### 开发命令
|
||||||
|
```bash
|
||||||
|
# 后端
|
||||||
|
cd backend
|
||||||
|
pnpm start:dev # 启动开发服务器
|
||||||
|
pnpm prisma:migrate:dev # 数据库迁移
|
||||||
|
pnpm init:admin # 初始化管理员
|
||||||
|
|
||||||
|
# 前端
|
||||||
|
cd frontend
|
||||||
|
pnpm dev # 启动开发服务器
|
||||||
|
pnpm build # 构建生产版本
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
💡 **记住**:租户隔离是系统的核心安全机制,所有数据操作都必须验证 `tenantId`!
|
||||||
|
|
||||||
180
CLAUDE.md
Normal file
180
CLAUDE.md
Normal file
@ -0,0 +1,180 @@
|
|||||||
|
# CLAUDE.md
|
||||||
|
|
||||||
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||||
|
|
||||||
|
## 项目概述
|
||||||
|
|
||||||
|
多租户少儿绘本创作活动/竞赛管理平台,前后端分离架构。
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
| 目录 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `backend-java/` | Spring Boot 后端(实际开发目录) |
|
||||||
|
| `frontend/` | Vue 3 前端(实际开发目录) |
|
||||||
|
| `lesingle-aicreate-client/` | AI 绘本创作客户端(独立模块) |
|
||||||
|
|
||||||
|
## 常用命令
|
||||||
|
|
||||||
|
### 后端 (backend-java/)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd backend-java
|
||||||
|
mvn spring-boot:run -Dspring.profiles.active=dev # 开发启动(端口 8580,上下文 /api)
|
||||||
|
mvn flyway:migrate # 执行数据库迁移
|
||||||
|
mvn clean package # 构建打包
|
||||||
|
```
|
||||||
|
|
||||||
|
### 前端 (frontend/)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
npm run dev # 开发模式(端口 3000,代理 /api → localhost:8580)
|
||||||
|
npm run build # 生产构建(base: /web/)
|
||||||
|
npm run build:test # 测试环境构建(base: /web-test/)
|
||||||
|
npm run lint # ESLint 检查
|
||||||
|
```
|
||||||
|
|
||||||
|
### AI创作客户端 (lesingle-aicreate-client/)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd lesingle-aicreate-client
|
||||||
|
npm install && npm run dev # 独立启动
|
||||||
|
```
|
||||||
|
|
||||||
|
## 技术栈
|
||||||
|
|
||||||
|
| 层级 | 技术 |
|
||||||
|
|------|------|
|
||||||
|
| 后端框架 | Spring Boot 3.2.5 + Java 17 |
|
||||||
|
| ORM | MyBatis-Plus 3.5.7 |
|
||||||
|
| 数据库 | MySQL 8.0 + Flyway 迁移 |
|
||||||
|
| 认证 | Spring Security + JWT |
|
||||||
|
| 缓存 | Redis |
|
||||||
|
| 工具库 | Hutool 5.8 + FastJSON2 + Knife4j 4.4(API文档) |
|
||||||
|
| 前端框架 | Vue 3 + TypeScript + Vite 5 |
|
||||||
|
| UI | Ant Design Vue 4.1 |
|
||||||
|
| 状态管理 | Pinia |
|
||||||
|
| 样式 | Tailwind CSS + SCSS |
|
||||||
|
| 表单验证 | VeeValidate + Zod |
|
||||||
|
| 富文本 | WangEditor |
|
||||||
|
| 图表 | ECharts |
|
||||||
|
|
||||||
|
## 后端架构 (backend-java/)
|
||||||
|
|
||||||
|
### 基础包: `com.competition`
|
||||||
|
|
||||||
|
### 三层架构
|
||||||
|
|
||||||
|
| 层级 | 职责 | 规范 |
|
||||||
|
|------|------|------|
|
||||||
|
| Controller | HTTP 请求处理、参数校验、Entity↔VO 转换 | 统一返回 `Result<T>` |
|
||||||
|
| Service | 业务逻辑、事务控制 | 接口 `I{Module}Service`,继承 `IService<T>` |
|
||||||
|
| Mapper | 数据库 CRUD | 继承 `BaseMapper<T>` |
|
||||||
|
|
||||||
|
**核心原则**: Service/Mapper 层使用 Entity,VO 转换只在 Controller 层。
|
||||||
|
|
||||||
|
### 模块划分
|
||||||
|
|
||||||
|
```
|
||||||
|
com.competition.modules/
|
||||||
|
├── biz/
|
||||||
|
│ ├── contest/ # 赛事管理(/contests)
|
||||||
|
│ ├── homework/ # 作业管理(/homework)
|
||||||
|
│ ├── judge/ # 评委管理
|
||||||
|
│ └── review/ # 评审管理(/contest-reviews, /contest-results)
|
||||||
|
├── sys/ # 系统管理(用户/角色/权限/租户,/sys/*)
|
||||||
|
├── user/ # 用户模块
|
||||||
|
├── ugc/ # 用户生成内容
|
||||||
|
├── pub/ # 公开接口(/public/*,无需认证)
|
||||||
|
└── oss/ # 对象存储(/oss/upload)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 实体基类 (BaseEntity)
|
||||||
|
|
||||||
|
所有实体继承 `BaseEntity`,包含字段:`id`、`createBy`、`updateBy`、`createTime`、`modifyTime`、`deleted`、`validState`。
|
||||||
|
|
||||||
|
表名规范:业务表 `t_biz_*`、系统表 `t_sys_*`、用户表 `t_user_*`。
|
||||||
|
|
||||||
|
### 多租户
|
||||||
|
|
||||||
|
- 所有业务表包含 `tenant_id` 字段
|
||||||
|
- 获取租户ID: `SecurityUtil.getCurrentTenantId()`
|
||||||
|
- 超级管理员 `isSuperAdmin()` 可访问所有租户数据
|
||||||
|
- 请求头通过 `X-Tenant-Code`、`X-Tenant-Id` 传递
|
||||||
|
|
||||||
|
### 认证与权限
|
||||||
|
|
||||||
|
- JWT Token payload: `{sub: userId, username, tenantId}`
|
||||||
|
- 公开接口: `@Public` 注解或路径 `/public/**`
|
||||||
|
- 权限控制: `@RequirePermission` 注解
|
||||||
|
|
||||||
|
### 统一响应格式
|
||||||
|
|
||||||
|
```java
|
||||||
|
Result<T> → {code, message, data, timestamp, path}
|
||||||
|
PageResult<T> → {list, total, page, pageSize}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 数据库迁移
|
||||||
|
|
||||||
|
- 位置: `src/main/resources/db/migration/`
|
||||||
|
- 命名: `V{number}__description.sql`(注意双下划线)
|
||||||
|
- 不使用外键约束,关联关系通过代码控制
|
||||||
|
|
||||||
|
## 前端架构 (frontend/)
|
||||||
|
|
||||||
|
### 路由与多租户
|
||||||
|
|
||||||
|
- 路由路径包含租户编码: `/:tenantCode/login`、`/:tenantCode/dashboard`
|
||||||
|
- 动态路由: 根据用户权限菜单动态生成
|
||||||
|
- 双模式: 管理端(需认证)+ 公众端(无需认证)
|
||||||
|
|
||||||
|
### 三种布局
|
||||||
|
|
||||||
|
| 布局 | 用途 |
|
||||||
|
|------|------|
|
||||||
|
| BasicLayout | 管理端(侧边栏+顶栏+面包屑) |
|
||||||
|
| PublicLayout | 公众端(简洁导航) |
|
||||||
|
| EmptyLayout | 全屏页面 |
|
||||||
|
|
||||||
|
### API 调用模式
|
||||||
|
|
||||||
|
API 模块位于 `src/api/`,Axios 实例在 `src/utils/request.ts`:
|
||||||
|
- 请求拦截器自动添加 Authorization token 和租户头
|
||||||
|
- 响应拦截器统一错误处理(401 跳转登录,403 提示)
|
||||||
|
- 函数命名: `getXxx`、`createXxx`、`updateXxx`、`deleteXxx`
|
||||||
|
|
||||||
|
### 权限控制
|
||||||
|
|
||||||
|
- 路由级: `meta.permissions`
|
||||||
|
- 组件级: `v-permission` 自定义指令
|
||||||
|
- 方法级: `hasPermission()`、`hasAnyPermission()`、`isSuperAdmin()`
|
||||||
|
|
||||||
|
### 状态管理
|
||||||
|
|
||||||
|
- auth Store: 用户信息、token、菜单、权限检查
|
||||||
|
- Token 存储在 Cookie 中
|
||||||
|
|
||||||
|
## 开发规范
|
||||||
|
|
||||||
|
- **日志/注释使用中文**
|
||||||
|
- **Git 提交格式**: `类型: 描述`(如 `feat: 添加XX功能`、`fix: 修复XX问题`)
|
||||||
|
- **组件语法**: `<script setup lang="ts">`
|
||||||
|
- **文件命名**: 组件 PascalCase,其他 kebab-case
|
||||||
|
- **数据库**: 不使用外键,关联通过代码控制
|
||||||
|
- **逻辑删除**: `deleted` 字段
|
||||||
|
|
||||||
|
## 环境配置
|
||||||
|
|
||||||
|
| 环境 | 后端 Profile | 前端 base | 后端端口 |
|
||||||
|
|------|-------------|-----------|---------|
|
||||||
|
| 开发 | dev | `/` | 8580 |
|
||||||
|
| 测试 | test | `/web-test/` | 8580 |
|
||||||
|
| 生产 | prod | `/web/` | 8580 |
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
- `.cursor/rules/` 中部分规范(如 NestJS、Prisma)是旧版配置,当前后端已迁移至 Spring Boot + MyBatis-Plus,以本文件为准
|
||||||
|
- 当前项目未配置测试框架
|
||||||
|
- 当前项目未配置 i18n,所有文本为中文硬编码
|
||||||
306
README.md
306
README.md
@ -1,3 +1,303 @@
|
|||||||
# library-picturebook-workshop
|
# 比赛管理系统
|
||||||
|
|
||||||
图书馆绘本创作活动 - 幼儿绘本创作与展示平台
|
一个基于 Vue 3 + NestJS 的现代化比赛管理系统,支持用户管理、角色权限、菜单管理、数据字典、系统配置和日志记录等核心功能。
|
||||||
|
|
||||||
|
## 技术栈
|
||||||
|
|
||||||
|
### 前端
|
||||||
|
- **框架**: Vue 3 + TypeScript
|
||||||
|
- **构建工具**: Vite
|
||||||
|
- **UI 组件库**: Ant Design Vue
|
||||||
|
- **样式方案**: Tailwind CSS + SCSS + CSS Modules
|
||||||
|
- **状态管理**: Pinia
|
||||||
|
- **路由**: Vue Router 4
|
||||||
|
- **HTTP 客户端**: Axios
|
||||||
|
- **表单验证**: VeeValidate + Zod
|
||||||
|
|
||||||
|
### 后端
|
||||||
|
- **框架**: NestJS + TypeScript
|
||||||
|
- **数据库**: MySQL 8.0
|
||||||
|
- **ORM**: Prisma
|
||||||
|
- **认证授权**: JWT + RBAC (基于角色的访问控制)
|
||||||
|
|
||||||
|
## 项目结构
|
||||||
|
|
||||||
|
```
|
||||||
|
competition-management-system/
|
||||||
|
├── frontend/ # 前端项目
|
||||||
|
│ ├── src/
|
||||||
|
│ │ ├── api/ # API 接口
|
||||||
|
│ │ ├── assets/ # 静态资源
|
||||||
|
│ │ ├── components/# 公共组件
|
||||||
|
│ │ ├── layouts/ # 布局组件
|
||||||
|
│ │ ├── router/ # 路由配置
|
||||||
|
│ │ ├── stores/ # Pinia 状态管理
|
||||||
|
│ │ ├── styles/ # 样式文件
|
||||||
|
│ │ ├── types/ # TypeScript 类型定义
|
||||||
|
│ │ ├── utils/ # 工具函数
|
||||||
|
│ │ └── views/ # 页面组件
|
||||||
|
│ └── package.json
|
||||||
|
│
|
||||||
|
└── backend/ # 后端项目
|
||||||
|
├── prisma/ # Prisma 配置
|
||||||
|
│ └── schema.prisma
|
||||||
|
├── src/
|
||||||
|
│ ├── auth/ # 认证模块
|
||||||
|
│ ├── users/ # 用户管理
|
||||||
|
│ ├── roles/ # 角色管理
|
||||||
|
│ ├── menus/ # 菜单管理
|
||||||
|
│ ├── dict/ # 数据字典
|
||||||
|
│ ├── config/ # 系统配置
|
||||||
|
│ ├── logs/ # 日志记录
|
||||||
|
│ └── prisma/ # Prisma 服务
|
||||||
|
└── package.json
|
||||||
|
```
|
||||||
|
|
||||||
|
## 快速开始
|
||||||
|
|
||||||
|
### 环境要求
|
||||||
|
|
||||||
|
- Node.js >= 18.0.0
|
||||||
|
- pnpm >= 8.0.0
|
||||||
|
- MySQL >= 8.0
|
||||||
|
|
||||||
|
### 安装 pnpm
|
||||||
|
|
||||||
|
如果还没有安装 pnpm,可以通过以下方式安装:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 使用 npm 安装
|
||||||
|
npm install -g pnpm
|
||||||
|
|
||||||
|
# 或使用 corepack(Node.js 16.13+)
|
||||||
|
corepack enable
|
||||||
|
corepack prepare pnpm@latest --activate
|
||||||
|
```
|
||||||
|
|
||||||
|
### 快速安装(推荐)
|
||||||
|
|
||||||
|
在项目根目录执行:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 安装所有依赖(前端 + 后端)
|
||||||
|
pnpm install
|
||||||
|
|
||||||
|
# 或分别安装
|
||||||
|
pnpm --filter frontend install
|
||||||
|
pnpm --filter backend install
|
||||||
|
```
|
||||||
|
|
||||||
|
### 后端设置
|
||||||
|
|
||||||
|
1. 进入后端目录:
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
```
|
||||||
|
|
||||||
|
2. 安装依赖(如果未在根目录安装):
|
||||||
|
```bash
|
||||||
|
pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. 配置环境变量,创建 `.env` 文件:
|
||||||
|
```env
|
||||||
|
DATABASE_URL="mysql://user:password@localhost:3306/competition_management?schema=public"
|
||||||
|
JWT_SECRET="your-secret-key-change-in-production"
|
||||||
|
PORT=3001
|
||||||
|
```
|
||||||
|
|
||||||
|
4. 初始化数据库:
|
||||||
|
```bash
|
||||||
|
# 生成 Prisma Client
|
||||||
|
pnpm prisma:generate
|
||||||
|
|
||||||
|
# 运行数据库迁移
|
||||||
|
pnpm prisma:migrate
|
||||||
|
```
|
||||||
|
|
||||||
|
5. 启动开发服务器:
|
||||||
|
```bash
|
||||||
|
# 方式1:在后端目录
|
||||||
|
pnpm start:dev
|
||||||
|
|
||||||
|
# 方式2:在根目录
|
||||||
|
pnpm dev:backend
|
||||||
|
```
|
||||||
|
|
||||||
|
后端服务将在 `http://localhost:3001` 启动。
|
||||||
|
|
||||||
|
### 前端设置
|
||||||
|
|
||||||
|
1. 进入前端目录:
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
```
|
||||||
|
|
||||||
|
2. 安装依赖(如果未在根目录安装):
|
||||||
|
```bash
|
||||||
|
pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. 启动开发服务器:
|
||||||
|
```bash
|
||||||
|
# 方式1:在前端目录
|
||||||
|
pnpm dev
|
||||||
|
|
||||||
|
# 方式2:在根目录
|
||||||
|
pnpm dev:frontend
|
||||||
|
```
|
||||||
|
|
||||||
|
前端应用将在 `http://localhost:3000` 启动。
|
||||||
|
|
||||||
|
### 同时启动前后端
|
||||||
|
|
||||||
|
在项目根目录执行:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm dev
|
||||||
|
```
|
||||||
|
|
||||||
|
这将同时启动前端和后端开发服务器。
|
||||||
|
|
||||||
|
## 核心功能
|
||||||
|
|
||||||
|
### 1. 用户管理
|
||||||
|
- 用户列表查询(分页)
|
||||||
|
- 用户创建、编辑、删除
|
||||||
|
- 用户角色分配
|
||||||
|
|
||||||
|
### 2. 角色权限 (RBAC)
|
||||||
|
- 角色管理(创建、编辑、删除)
|
||||||
|
- 权限分配
|
||||||
|
- 基于角色的访问控制
|
||||||
|
|
||||||
|
### 3. 菜单管理
|
||||||
|
- 菜单树形结构管理
|
||||||
|
- 菜单权限配置
|
||||||
|
- 动态路由生成
|
||||||
|
|
||||||
|
### 4. 数据字典
|
||||||
|
- 字典类型管理
|
||||||
|
- 字典项管理
|
||||||
|
- 字典数据查询
|
||||||
|
|
||||||
|
### 5. 系统配置
|
||||||
|
- 系统参数配置
|
||||||
|
- 配置项管理
|
||||||
|
|
||||||
|
### 6. 日志记录
|
||||||
|
- 操作日志记录
|
||||||
|
- 日志查询和统计
|
||||||
|
|
||||||
|
## API 文档
|
||||||
|
|
||||||
|
### 认证接口
|
||||||
|
|
||||||
|
- `POST /api/auth/login` - 用户登录
|
||||||
|
- `GET /api/auth/user-info` - 获取当前用户信息
|
||||||
|
- `POST /api/auth/logout` - 用户登出
|
||||||
|
|
||||||
|
### 用户管理
|
||||||
|
|
||||||
|
- `GET /api/users` - 获取用户列表
|
||||||
|
- `GET /api/users/:id` - 获取用户详情
|
||||||
|
- `POST /api/users` - 创建用户
|
||||||
|
- `PATCH /api/users/:id` - 更新用户
|
||||||
|
- `DELETE /api/users/:id` - 删除用户
|
||||||
|
|
||||||
|
### 角色管理
|
||||||
|
|
||||||
|
- `GET /api/roles` - 获取角色列表
|
||||||
|
- `GET /api/roles/:id` - 获取角色详情
|
||||||
|
- `POST /api/roles` - 创建角色
|
||||||
|
- `PATCH /api/roles/:id` - 更新角色
|
||||||
|
- `DELETE /api/roles/:id` - 删除角色
|
||||||
|
|
||||||
|
### 菜单管理
|
||||||
|
|
||||||
|
- `GET /api/menus` - 获取菜单列表(树形结构)
|
||||||
|
- `GET /api/menus/:id` - 获取菜单详情
|
||||||
|
- `POST /api/menus` - 创建菜单
|
||||||
|
- `PATCH /api/menus/:id` - 更新菜单
|
||||||
|
- `DELETE /api/menus/:id` - 删除菜单
|
||||||
|
|
||||||
|
### 数据字典
|
||||||
|
|
||||||
|
- `GET /api/dict` - 获取字典列表
|
||||||
|
- `GET /api/dict/code/:code` - 根据代码获取字典
|
||||||
|
- `GET /api/dict/:id` - 获取字典详情
|
||||||
|
- `POST /api/dict` - 创建字典
|
||||||
|
- `PATCH /api/dict/:id` - 更新字典
|
||||||
|
- `DELETE /api/dict/:id` - 删除字典
|
||||||
|
|
||||||
|
### 系统配置
|
||||||
|
|
||||||
|
- `GET /api/config` - 获取配置列表
|
||||||
|
- `GET /api/config/key/:key` - 根据键获取配置
|
||||||
|
- `GET /api/config/:id` - 获取配置详情
|
||||||
|
- `POST /api/config` - 创建配置
|
||||||
|
- `PATCH /api/config/:id` - 更新配置
|
||||||
|
- `DELETE /api/config/:id` - 删除配置
|
||||||
|
|
||||||
|
### 日志记录
|
||||||
|
|
||||||
|
- `GET /api/logs` - 获取日志列表
|
||||||
|
- `GET /api/logs/:id` - 获取日志详情
|
||||||
|
- `POST /api/logs` - 创建日志
|
||||||
|
|
||||||
|
## 开发规范
|
||||||
|
|
||||||
|
### 代码风格
|
||||||
|
- 使用 ESLint 和 Prettier 进行代码格式化
|
||||||
|
- 遵循 TypeScript 严格模式
|
||||||
|
- 使用语义化的提交信息
|
||||||
|
|
||||||
|
### 提交规范
|
||||||
|
- `feat`: 新功能
|
||||||
|
- `fix`: 修复 bug
|
||||||
|
- `docs`: 文档更新
|
||||||
|
- `style`: 代码格式调整
|
||||||
|
- `refactor`: 代码重构
|
||||||
|
- `test`: 测试相关
|
||||||
|
- `chore`: 构建/工具相关
|
||||||
|
|
||||||
|
## 部署
|
||||||
|
|
||||||
|
### 前端构建
|
||||||
|
```bash
|
||||||
|
# 方式1:在前端目录
|
||||||
|
cd frontend
|
||||||
|
pnpm build
|
||||||
|
|
||||||
|
# 方式2:在根目录
|
||||||
|
pnpm build:frontend
|
||||||
|
```
|
||||||
|
|
||||||
|
构建产物在 `frontend/dist` 目录。
|
||||||
|
|
||||||
|
### 后端构建
|
||||||
|
```bash
|
||||||
|
# 方式1:在后端目录
|
||||||
|
cd backend
|
||||||
|
pnpm build
|
||||||
|
pnpm start:prod
|
||||||
|
|
||||||
|
# 方式2:在根目录
|
||||||
|
pnpm build:backend
|
||||||
|
cd backend
|
||||||
|
pnpm start:prod
|
||||||
|
```
|
||||||
|
|
||||||
|
### 同时构建前后端
|
||||||
|
```bash
|
||||||
|
pnpm build
|
||||||
|
```
|
||||||
|
|
||||||
|
## 许可证
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
## 贡献
|
||||||
|
|
||||||
|
欢迎提交 Issue 和 Pull Request!
|
||||||
|
|
||||||
|
|||||||
5
backend-java/.gitignore
vendored
Normal file
5
backend-java/.gitignore
vendored
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
target/
|
||||||
|
uploads/
|
||||||
|
*.log
|
||||||
|
.idea/
|
||||||
|
*.iml
|
||||||
198
backend-java/pom.xml
Normal file
198
backend-java/pom.xml
Normal file
@ -0,0 +1,198 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
|
<parent>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-parent</artifactId>
|
||||||
|
<version>3.2.5</version>
|
||||||
|
<relativePath/>
|
||||||
|
</parent>
|
||||||
|
|
||||||
|
<groupId>com.competition</groupId>
|
||||||
|
<artifactId>competition-management-system</artifactId>
|
||||||
|
<version>1.0.0</version>
|
||||||
|
<name>competition-management-system</name>
|
||||||
|
<description>少儿绘本创作活动管理平台 - Java 后端</description>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<java.version>17</java.version>
|
||||||
|
<mybatis-plus.version>3.5.7</mybatis-plus.version>
|
||||||
|
<druid.version>1.2.23</druid.version>
|
||||||
|
<jjwt.version>0.12.6</jjwt.version>
|
||||||
|
<knife4j.version>4.4.0</knife4j.version>
|
||||||
|
<mapstruct.version>1.5.5.Final</mapstruct.version>
|
||||||
|
<hutool.version>5.8.32</hutool.version>
|
||||||
|
<fastjson2.version>2.0.53</fastjson2.version>
|
||||||
|
<aliyun-oss.version>3.17.1</aliyun-oss.version>
|
||||||
|
</properties>
|
||||||
|
|
||||||
|
<dependencies>
|
||||||
|
<!-- Spring Boot Starters -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-web</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-security</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-validation</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-data-redis</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-aop</artifactId>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- MyBatis-Plus -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.baomidou</groupId>
|
||||||
|
<artifactId>mybatis-plus-spring-boot3-starter</artifactId>
|
||||||
|
<version>${mybatis-plus.version}</version>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Druid 连接池 -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.alibaba</groupId>
|
||||||
|
<artifactId>druid-spring-boot-3-starter</artifactId>
|
||||||
|
<version>${druid.version}</version>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- MySQL 驱动 -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.mysql</groupId>
|
||||||
|
<artifactId>mysql-connector-j</artifactId>
|
||||||
|
<scope>runtime</scope>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Flyway 数据库迁移 -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.flywaydb</groupId>
|
||||||
|
<artifactId>flyway-core</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.flywaydb</groupId>
|
||||||
|
<artifactId>flyway-mysql</artifactId>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- JWT -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.jsonwebtoken</groupId>
|
||||||
|
<artifactId>jjwt-api</artifactId>
|
||||||
|
<version>${jjwt.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.jsonwebtoken</groupId>
|
||||||
|
<artifactId>jjwt-impl</artifactId>
|
||||||
|
<version>${jjwt.version}</version>
|
||||||
|
<scope>runtime</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.jsonwebtoken</groupId>
|
||||||
|
<artifactId>jjwt-jackson</artifactId>
|
||||||
|
<version>${jjwt.version}</version>
|
||||||
|
<scope>runtime</scope>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Knife4j API 文档 -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.github.xiaoymin</groupId>
|
||||||
|
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
|
||||||
|
<version>${knife4j.version}</version>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- MapStruct -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.mapstruct</groupId>
|
||||||
|
<artifactId>mapstruct</artifactId>
|
||||||
|
<version>${mapstruct.version}</version>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Hutool 工具集 -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>cn.hutool</groupId>
|
||||||
|
<artifactId>hutool-all</artifactId>
|
||||||
|
<version>${hutool.version}</version>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- FastJSON2 -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.alibaba.fastjson2</groupId>
|
||||||
|
<artifactId>fastjson2</artifactId>
|
||||||
|
<version>${fastjson2.version}</version>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- 阿里云 OSS -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.aliyun.oss</groupId>
|
||||||
|
<artifactId>aliyun-sdk-oss</artifactId>
|
||||||
|
<version>${aliyun-oss.version}</version>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Lombok -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.projectlombok</groupId>
|
||||||
|
<artifactId>lombok</artifactId>
|
||||||
|
<optional>true</optional>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Test -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-test</artifactId>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
|
||||||
|
<build>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-maven-plugin</artifactId>
|
||||||
|
<configuration>
|
||||||
|
<excludes>
|
||||||
|
<exclude>
|
||||||
|
<groupId>org.projectlombok</groupId>
|
||||||
|
<artifactId>lombok</artifactId>
|
||||||
|
</exclude>
|
||||||
|
</excludes>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-compiler-plugin</artifactId>
|
||||||
|
<configuration>
|
||||||
|
<source>${java.version}</source>
|
||||||
|
<target>${java.version}</target>
|
||||||
|
<annotationProcessorPaths>
|
||||||
|
<path>
|
||||||
|
<groupId>org.projectlombok</groupId>
|
||||||
|
<artifactId>lombok</artifactId>
|
||||||
|
<version>${lombok.version}</version>
|
||||||
|
</path>
|
||||||
|
<path>
|
||||||
|
<groupId>org.mapstruct</groupId>
|
||||||
|
<artifactId>mapstruct-processor</artifactId>
|
||||||
|
<version>${mapstruct.version}</version>
|
||||||
|
</path>
|
||||||
|
<!-- Lombok-MapStruct 绑定,确保 MapStruct 能识别 Lombok 生成的方法 -->
|
||||||
|
<path>
|
||||||
|
<groupId>org.projectlombok</groupId>
|
||||||
|
<artifactId>lombok-mapstruct-binding</artifactId>
|
||||||
|
<version>0.2.0</version>
|
||||||
|
</path>
|
||||||
|
</annotationProcessorPaths>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
|
||||||
|
</project>
|
||||||
@ -0,0 +1,23 @@
|
|||||||
|
package com.competition;
|
||||||
|
|
||||||
|
import org.mybatis.spring.annotation.MapperScan;
|
||||||
|
import org.springframework.boot.SpringApplication;
|
||||||
|
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||||
|
|
||||||
|
@SpringBootApplication
|
||||||
|
@MapperScan({
|
||||||
|
"com.competition.modules.sys.mapper",
|
||||||
|
"com.competition.modules.biz.contest.mapper",
|
||||||
|
"com.competition.modules.biz.review.mapper",
|
||||||
|
"com.competition.modules.biz.homework.mapper",
|
||||||
|
"com.competition.modules.biz.judge.mapper",
|
||||||
|
"com.competition.modules.user.mapper",
|
||||||
|
"com.competition.modules.ugc.mapper",
|
||||||
|
"com.competition.modules.leai.mapper"
|
||||||
|
})
|
||||||
|
public class CompetitionApplication {
|
||||||
|
|
||||||
|
public static void main(String[] args) {
|
||||||
|
SpringApplication.run(CompetitionApplication.class, args);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,34 @@
|
|||||||
|
package com.competition.common.annotation;
|
||||||
|
|
||||||
|
import java.lang.annotation.*;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 接口速率限制注解
|
||||||
|
* 用于公开接口防止恶意调用
|
||||||
|
*/
|
||||||
|
@Target(ElementType.METHOD)
|
||||||
|
@Retention(RetentionPolicy.RUNTIME)
|
||||||
|
@Documented
|
||||||
|
public @interface RateLimit {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 时间窗口内允许的最大请求次数
|
||||||
|
*/
|
||||||
|
int permits() default 10;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 时间窗口大小
|
||||||
|
*/
|
||||||
|
long duration() default 1;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 时间单位
|
||||||
|
*/
|
||||||
|
TimeUnit timeUnit() default TimeUnit.SECONDS;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 限制维度:ip / user
|
||||||
|
*/
|
||||||
|
String key() default "ip";
|
||||||
|
}
|
||||||
@ -0,0 +1,49 @@
|
|||||||
|
package com.competition.common.config;
|
||||||
|
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.boot.ApplicationArguments;
|
||||||
|
import org.springframework.boot.ApplicationRunner;
|
||||||
|
import org.springframework.jdbc.core.JdbcTemplate;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 数据库启动时轻量修复:
|
||||||
|
* 由于本项目部分环境可能没有跑过最新的 init.sql,
|
||||||
|
* 导致 `t_biz_contest_work` 缺少 `deleted` 字段,从而 MyBatis-Plus 逻辑删除查询报 500。
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@Component
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class ContestWorkSchemaRepair implements ApplicationRunner {
|
||||||
|
|
||||||
|
private final JdbcTemplate jdbcTemplate;
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void run(ApplicationArguments args) {
|
||||||
|
try {
|
||||||
|
Integer columnCnt = jdbcTemplate.queryForObject(
|
||||||
|
"SELECT COUNT(*) " +
|
||||||
|
"FROM information_schema.columns " +
|
||||||
|
"WHERE table_schema = DATABASE() " +
|
||||||
|
"AND table_name = 't_biz_contest_work' " +
|
||||||
|
"AND column_name = 'deleted'",
|
||||||
|
Integer.class
|
||||||
|
);
|
||||||
|
|
||||||
|
if (columnCnt == null || columnCnt == 0) {
|
||||||
|
log.warn("检测到表 `t_biz_contest_work` 缺少字段 `deleted`,尝试补齐...");
|
||||||
|
jdbcTemplate.execute(
|
||||||
|
"ALTER TABLE t_biz_contest_work " +
|
||||||
|
"ADD COLUMN deleted tinyint NOT NULL DEFAULT '0' " +
|
||||||
|
"COMMENT '逻辑删除:0-未删除,1-已删除'"
|
||||||
|
);
|
||||||
|
log.info("补齐字段 `t_biz_contest_work.deleted` 完成");
|
||||||
|
}
|
||||||
|
} catch (Exception e) {
|
||||||
|
// 不阻断启动,给调用方避免 500 需要依赖数据库权限/执行成功
|
||||||
|
log.warn("补齐 `t_biz_contest_work.deleted` 失败:{}", e.getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
package com.competition.common.config;
|
||||||
|
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
import org.springframework.web.cors.CorsConfiguration;
|
||||||
|
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
|
||||||
|
import org.springframework.web.filter.CorsFilter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 跨域配置
|
||||||
|
* 允许所有来源访问,方便前后端分离开发部署
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@Configuration
|
||||||
|
public class CorsConfig {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
public CorsFilter corsFilter() {
|
||||||
|
CorsConfiguration config = new CorsConfiguration();
|
||||||
|
config.setAllowCredentials(true);
|
||||||
|
|
||||||
|
// 允许所有来源
|
||||||
|
config.addAllowedOriginPattern("*");
|
||||||
|
|
||||||
|
config.addAllowedHeader("*");
|
||||||
|
config.addAllowedMethod("*");
|
||||||
|
config.addExposedHeader("X-Trace-Id");
|
||||||
|
|
||||||
|
log.info("CORS 配置:允许所有来源(*)");
|
||||||
|
|
||||||
|
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
|
||||||
|
source.registerCorsConfiguration("/**", config);
|
||||||
|
return new CorsFilter(source);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,24 @@
|
|||||||
|
package com.competition.common.config;
|
||||||
|
|
||||||
|
import org.flywaydb.core.Flyway;
|
||||||
|
import org.springframework.boot.autoconfigure.flyway.FlywayMigrationStrategy;
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Flyway 修复配置
|
||||||
|
* 启动时自动修复失败的迁移记录,然后执行迁移
|
||||||
|
*/
|
||||||
|
@Configuration
|
||||||
|
public class FlywayRepairConfig {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
public FlywayMigrationStrategy flywayMigrationStrategy() {
|
||||||
|
return flyway -> {
|
||||||
|
// 先修复失败的迁移记录
|
||||||
|
flyway.repair();
|
||||||
|
// 然后执行迁移
|
||||||
|
flyway.migrate();
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,29 @@
|
|||||||
|
package com.competition.common.config;
|
||||||
|
|
||||||
|
import io.swagger.v3.oas.models.OpenAPI;
|
||||||
|
import io.swagger.v3.oas.models.info.Info;
|
||||||
|
import io.swagger.v3.oas.models.security.SecurityRequirement;
|
||||||
|
import io.swagger.v3.oas.models.security.SecurityScheme;
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Knife4j / OpenAPI 配置
|
||||||
|
*/
|
||||||
|
@Configuration
|
||||||
|
public class Knife4jConfig {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
public OpenAPI openAPI() {
|
||||||
|
return new OpenAPI()
|
||||||
|
.info(new Info()
|
||||||
|
.title("少儿绘本创作活动管理平台 API")
|
||||||
|
.description("Competition Management System - Java Backend")
|
||||||
|
.version("1.0.0"))
|
||||||
|
.addSecurityItem(new SecurityRequirement().addList("Bearer"))
|
||||||
|
.schemaRequirement("Bearer", new SecurityScheme()
|
||||||
|
.type(SecurityScheme.Type.HTTP)
|
||||||
|
.scheme("bearer")
|
||||||
|
.bearerFormat("JWT"));
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
package com.competition.common.config;
|
||||||
|
|
||||||
|
import com.baomidou.mybatisplus.annotation.DbType;
|
||||||
|
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
|
||||||
|
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* MyBatis-Plus 配置
|
||||||
|
*/
|
||||||
|
@Configuration
|
||||||
|
public class MyBatisPlusConfig {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
public MybatisPlusInterceptor mybatisPlusInterceptor() {
|
||||||
|
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
|
||||||
|
// 分页插件
|
||||||
|
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
|
||||||
|
return interceptor;
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,21 @@
|
|||||||
|
package com.competition.common.config;
|
||||||
|
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
import org.springframework.http.client.SimpleClientHttpRequestFactory;
|
||||||
|
import org.springframework.web.client.RestTemplate;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RestTemplate 配置
|
||||||
|
*/
|
||||||
|
@Configuration
|
||||||
|
public class RestTemplateConfig {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
public RestTemplate restTemplate() {
|
||||||
|
SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
|
||||||
|
factory.setConnectTimeout(10_000);
|
||||||
|
factory.setReadTimeout(10_000);
|
||||||
|
return new RestTemplate(factory);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
package com.competition.common.config;
|
||||||
|
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
import org.springframework.scheduling.annotation.EnableScheduling;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 定时任务配置
|
||||||
|
*/
|
||||||
|
@Configuration
|
||||||
|
@EnableScheduling
|
||||||
|
public class SchedulingConfig {
|
||||||
|
}
|
||||||
@ -0,0 +1,27 @@
|
|||||||
|
package com.competition.common.config;
|
||||||
|
|
||||||
|
import com.competition.common.interceptor.RateLimitInterceptor;
|
||||||
|
import com.competition.common.interceptor.TraceIdInterceptor;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
|
||||||
|
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* WebMvc 配置
|
||||||
|
*/
|
||||||
|
@Configuration
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class WebMvcConfig implements WebMvcConfigurer {
|
||||||
|
|
||||||
|
private final TraceIdInterceptor traceIdInterceptor;
|
||||||
|
private final RateLimitInterceptor rateLimitInterceptor;
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void addInterceptors(InterceptorRegistry registry) {
|
||||||
|
registry.addInterceptor(traceIdInterceptor).addPathPatterns("/**");
|
||||||
|
// 速率限制拦截器,仅对公开接口生效
|
||||||
|
registry.addInterceptor(rateLimitInterceptor)
|
||||||
|
.addPathPatterns("/public/**", "/webhook/**");
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,21 @@
|
|||||||
|
package com.competition.common.constants;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* BaseEntity 基础字段常量
|
||||||
|
*/
|
||||||
|
public final class BaseEntityConstants {
|
||||||
|
|
||||||
|
private BaseEntityConstants() {}
|
||||||
|
|
||||||
|
/** 未删除 */
|
||||||
|
public static final int NOT_DELETED = 0;
|
||||||
|
|
||||||
|
/** 已删除 */
|
||||||
|
public static final int DELETED = 1;
|
||||||
|
|
||||||
|
/** 有效状态 */
|
||||||
|
public static final int VALID = 1;
|
||||||
|
|
||||||
|
/** 无效状态 */
|
||||||
|
public static final int INVALID = 2;
|
||||||
|
}
|
||||||
@ -0,0 +1,21 @@
|
|||||||
|
package com.competition.common.constants;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 缓存相关常量
|
||||||
|
*/
|
||||||
|
public final class CacheConstants {
|
||||||
|
|
||||||
|
private CacheConstants() {}
|
||||||
|
|
||||||
|
/** 用户角色缓存 key 前缀 */
|
||||||
|
public static final String USER_ROLES_PREFIX = "user:roles:";
|
||||||
|
|
||||||
|
/** 用户权限缓存 key 前缀 */
|
||||||
|
public static final String USER_PERMS_PREFIX = "user:perms:";
|
||||||
|
|
||||||
|
/** 认证缓存天数 */
|
||||||
|
public static final int AUTH_CACHE_DAYS = 7;
|
||||||
|
|
||||||
|
/** Token 黑名单 key 前缀(用于登出/密码修改后使旧 Token 失效) */
|
||||||
|
public static final String TOKEN_BLACKLIST_PREFIX = "token:blacklist:";
|
||||||
|
}
|
||||||
@ -0,0 +1,21 @@
|
|||||||
|
package com.competition.common.constants;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 角色相关常量
|
||||||
|
*/
|
||||||
|
public final class RoleConstants {
|
||||||
|
|
||||||
|
private RoleConstants() {}
|
||||||
|
|
||||||
|
/** 超级管理员角色编码 */
|
||||||
|
public static final String SUPER_ADMIN = "super_admin";
|
||||||
|
|
||||||
|
/** 公众用户角色编码 */
|
||||||
|
public static final String PUBLIC_USER = "public_user";
|
||||||
|
|
||||||
|
/** 评委角色编码 */
|
||||||
|
public static final String JUDGE = "judge";
|
||||||
|
|
||||||
|
/** 租户管理员角色编码 */
|
||||||
|
public static final String TENANT_ADMIN = "tenant_admin";
|
||||||
|
}
|
||||||
@ -0,0 +1,23 @@
|
|||||||
|
package com.competition.common.constants;
|
||||||
|
|
||||||
|
import java.util.Set;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 租户相关常量
|
||||||
|
*/
|
||||||
|
public final class TenantConstants {
|
||||||
|
|
||||||
|
private TenantConstants() {}
|
||||||
|
|
||||||
|
/** 超级管理员租户编码 */
|
||||||
|
public static final String CODE_SUPER = "super";
|
||||||
|
|
||||||
|
/** 公众端租户编码 */
|
||||||
|
public static final String CODE_PUBLIC = "public";
|
||||||
|
|
||||||
|
/** 评委租户编码 */
|
||||||
|
public static final String CODE_JUDGE = "judge";
|
||||||
|
|
||||||
|
/** 内部系统租户编码集合(不可删除、不可注册) */
|
||||||
|
public static final Set<String> INTERNAL_TENANT_CODES = Set.of(CODE_SUPER, CODE_PUBLIC, CODE_JUDGE, "school", "teacher", "student");
|
||||||
|
}
|
||||||
@ -0,0 +1,69 @@
|
|||||||
|
package com.competition.common.entity;
|
||||||
|
|
||||||
|
import com.baomidou.mybatisplus.annotation.*;
|
||||||
|
import io.swagger.v3.oas.annotations.media.Schema;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
import java.io.Serializable;
|
||||||
|
import java.time.LocalDateTime;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 基础实体类,所有实体继承此类
|
||||||
|
* 包含新审计字段(Java规范)和旧审计字段(过渡期兼容)
|
||||||
|
*/
|
||||||
|
@Data
|
||||||
|
@Schema(description = "基础实体")
|
||||||
|
public abstract class BaseEntity implements Serializable {
|
||||||
|
|
||||||
|
/** 主键 ID(自增) */
|
||||||
|
@Schema(description = "主键ID")
|
||||||
|
@TableId(type = IdType.AUTO)
|
||||||
|
private Long id;
|
||||||
|
|
||||||
|
// ====== 新审计字段(Java 规范) ======
|
||||||
|
|
||||||
|
/** 创建人账号 */
|
||||||
|
@Schema(description = "创建人账号")
|
||||||
|
@TableField(value = "create_by", fill = FieldFill.INSERT)
|
||||||
|
private String createBy;
|
||||||
|
|
||||||
|
/** 更新人账号 */
|
||||||
|
@Schema(description = "更新人账号")
|
||||||
|
@TableField(value = "update_by", fill = FieldFill.INSERT_UPDATE)
|
||||||
|
private String updateBy;
|
||||||
|
|
||||||
|
/** 逻辑删除标识(0-未删除,1-已删除) */
|
||||||
|
@Schema(description = "逻辑删除标识:0-未删除,1-已删除")
|
||||||
|
@TableLogic
|
||||||
|
@TableField(value = "deleted", fill = FieldFill.INSERT)
|
||||||
|
private Integer deleted;
|
||||||
|
|
||||||
|
// ====== 旧审计字段(过渡期保留,请使用 createBy/updateBy) ======
|
||||||
|
|
||||||
|
/** 创建人 ID(已弃用,请使用 createBy) */
|
||||||
|
@Deprecated
|
||||||
|
@Schema(description = "创建人ID(已弃用,请使用 createBy)")
|
||||||
|
@TableField(value = "creator", fill = FieldFill.INSERT)
|
||||||
|
private Integer creator;
|
||||||
|
|
||||||
|
/** 修改人 ID(已弃用,请使用 updateBy) */
|
||||||
|
@Deprecated
|
||||||
|
@Schema(description = "修改人ID(已弃用,请使用 updateBy)")
|
||||||
|
@TableField(value = "modifier", fill = FieldFill.INSERT_UPDATE)
|
||||||
|
private Integer modifier;
|
||||||
|
|
||||||
|
/** 创建时间 */
|
||||||
|
@Schema(description = "创建时间")
|
||||||
|
@TableField(value = "create_time", fill = FieldFill.INSERT)
|
||||||
|
private LocalDateTime createTime;
|
||||||
|
|
||||||
|
/** 修改时间 */
|
||||||
|
@Schema(description = "修改时间")
|
||||||
|
@TableField(value = "modify_time", fill = FieldFill.INSERT_UPDATE)
|
||||||
|
private LocalDateTime modifyTime;
|
||||||
|
|
||||||
|
/** 有效状态:1-有效,2-失效 */
|
||||||
|
@Schema(description = "有效状态:1-有效,2-失效")
|
||||||
|
@TableField(value = "valid_state", fill = FieldFill.INSERT)
|
||||||
|
private Integer validState;
|
||||||
|
}
|
||||||
@ -0,0 +1,18 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 通用状态枚举(启用/禁用)
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum CommonStatus {
|
||||||
|
|
||||||
|
ENABLED("enabled", "启用"),
|
||||||
|
DISABLED("disabled", "禁用");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,58 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 错误码枚举
|
||||||
|
* HTTP 状态码级别 + 业务错误码分组
|
||||||
|
* 10xx 用户模块 / 20xx 活动模块 / 30xx 评审模块 / 40xx 作品模块 / 50xx 系统模块
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum ErrorCode {
|
||||||
|
|
||||||
|
// ====== HTTP 状态码级别 ======
|
||||||
|
SUCCESS(200, "success"),
|
||||||
|
BAD_REQUEST(400, "请求参数错误"),
|
||||||
|
UNAUTHORIZED(401, "未登录或 Token 已过期"),
|
||||||
|
FORBIDDEN(403, "没有访问权限"),
|
||||||
|
NOT_FOUND(404, "资源不存在"),
|
||||||
|
CONFLICT(409, "数据冲突"),
|
||||||
|
INTERNAL_ERROR(500, "系统内部错误"),
|
||||||
|
|
||||||
|
// ====== 用户模块 10xx ======
|
||||||
|
USER_NOT_FOUND(1001, "用户不存在"),
|
||||||
|
USER_DISABLED(1002, "用户已被禁用"),
|
||||||
|
USER_PASSWORD_ERROR(1003, "密码错误"),
|
||||||
|
USER_DUPLICATE(1004, "用户名已存在"),
|
||||||
|
USER_PHONE_DUPLICATE(1005, "手机号已注册"),
|
||||||
|
|
||||||
|
// ====== 活动模块 20xx ======
|
||||||
|
CONTEST_NOT_FOUND(2001, "活动不存在"),
|
||||||
|
CONTEST_ALREADY_PUBLISHED(2002, "活动已发布"),
|
||||||
|
CONTEST_NOT_PUBLISHED(2003, "活动未发布"),
|
||||||
|
CONTEST_TIME_INVALID(2004, "活动时间配置无效"),
|
||||||
|
CONTEST_REGISTRATION_CLOSED(2005, "报名已截止"),
|
||||||
|
CONTEST_SUBMIT_CLOSED(2006, "提交已截止"),
|
||||||
|
CONTEST_ALREADY_FINISHED(2007, "活动已结束"),
|
||||||
|
CONTEST_REVIEW_INCOMPLETE(2008, "评审未完成"),
|
||||||
|
|
||||||
|
// ====== 评审模块 30xx ======
|
||||||
|
REVIEW_NOT_FOUND(3001, "评审记录不存在"),
|
||||||
|
REVIEW_ALREADY_SCORED(3002, "已评分,请勿重复提交"),
|
||||||
|
REVIEW_FINAL_SCORE_LOCKED(3003, "终分已锁定,无法修改评分"),
|
||||||
|
REVIEW_NOT_ASSIGNED(3004, "作品未分配给该评委"),
|
||||||
|
|
||||||
|
// ====== 作品模块 40xx ======
|
||||||
|
WORK_NOT_FOUND(4001, "作品不存在"),
|
||||||
|
WORK_ALREADY_SUBMITTED(4002, "作品已提交"),
|
||||||
|
WORK_RESUBMIT_NOT_ALLOWED(4003, "不允许重新提交"),
|
||||||
|
|
||||||
|
// ====== 文件上传模块 50xx ======
|
||||||
|
FILE_TYPE_NOT_ALLOWED(5001, "不支持的文件类型"),
|
||||||
|
FILE_SIZE_EXCEEDED(5002, "文件大小超限");
|
||||||
|
|
||||||
|
private final Integer code;
|
||||||
|
private final String message;
|
||||||
|
}
|
||||||
@ -0,0 +1,18 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 参赛者类型枚举
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum ParticipantType {
|
||||||
|
|
||||||
|
SELF("self", "本人"),
|
||||||
|
CHILD("child", "儿童");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,18 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 发布状态枚举
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum PublishStatus {
|
||||||
|
|
||||||
|
PUBLISHED("published", "已发布"),
|
||||||
|
UNPUBLISHED("unpublished", "未发布");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,19 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 报名状态枚举
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum RegistrationStatus {
|
||||||
|
|
||||||
|
PENDING("pending", "待审核"),
|
||||||
|
PASSED("passed", "已通过"),
|
||||||
|
REJECTED("rejected", "已拒绝");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,18 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 提交规则枚举
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum SubmitRule {
|
||||||
|
|
||||||
|
ONCE("once", "仅一次"),
|
||||||
|
RESUBMIT("resubmit", "可重提交");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 租户类型枚举
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum TenantType {
|
||||||
|
|
||||||
|
PLATFORM("platform", "平台"),
|
||||||
|
LIBRARY("library", "图书馆"),
|
||||||
|
KINDERGARTEN("kindergarten", "幼儿园"),
|
||||||
|
SCHOOL("school", "学校"),
|
||||||
|
INSTITUTION("institution", "机构"),
|
||||||
|
OTHER("other", "其他");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,19 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 用户来源枚举
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum UserSource {
|
||||||
|
|
||||||
|
ADMIN_CREATED("admin_created", "管理员创建"),
|
||||||
|
SELF_REGISTERED("self_registered", "自主注册"),
|
||||||
|
CHILD_MIGRATED("child_migrated", "儿童迁移");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,18 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 用户类型枚举
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum UserType {
|
||||||
|
|
||||||
|
ADULT("adult", "成人"),
|
||||||
|
CHILD("child", "儿童");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,20 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 可见性枚举
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum Visibility {
|
||||||
|
|
||||||
|
PUBLIC("public", "公开"),
|
||||||
|
DESIGNATED("designated", "指定"),
|
||||||
|
INTERNAL("internal", "内部"),
|
||||||
|
PRIVATE("private", "私有");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,23 @@
|
|||||||
|
package com.competition.common.enums;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 作品状态枚举
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@AllArgsConstructor
|
||||||
|
public enum WorkStatus {
|
||||||
|
|
||||||
|
SUBMITTED("submitted", "已提交"),
|
||||||
|
LOCKED("locked", "已锁定"),
|
||||||
|
REVIEWING("reviewing", "评审中"),
|
||||||
|
REJECTED("rejected", "已拒绝"),
|
||||||
|
ACCEPTED("accepted", "已采纳"),
|
||||||
|
AWARDED("awarded", "已获奖"),
|
||||||
|
TAKEN_DOWN("taken_down", "已下架");
|
||||||
|
|
||||||
|
private final String value;
|
||||||
|
private final String description;
|
||||||
|
}
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
package com.competition.common.exception;
|
||||||
|
|
||||||
|
import com.competition.common.enums.ErrorCode;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 业务异常
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
public class BusinessException extends RuntimeException {
|
||||||
|
|
||||||
|
private final Integer code;
|
||||||
|
|
||||||
|
public BusinessException(Integer code, String message) {
|
||||||
|
super(message);
|
||||||
|
this.code = code;
|
||||||
|
}
|
||||||
|
|
||||||
|
public BusinessException(ErrorCode errorCode) {
|
||||||
|
super(errorCode.getMessage());
|
||||||
|
this.code = errorCode.getCode();
|
||||||
|
}
|
||||||
|
|
||||||
|
public BusinessException(ErrorCode errorCode, String message) {
|
||||||
|
super(message);
|
||||||
|
this.code = errorCode.getCode();
|
||||||
|
}
|
||||||
|
|
||||||
|
public static BusinessException of(ErrorCode errorCode) {
|
||||||
|
return new BusinessException(errorCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static BusinessException of(ErrorCode errorCode, String message) {
|
||||||
|
return new BusinessException(errorCode, message);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,83 @@
|
|||||||
|
package com.competition.common.exception;
|
||||||
|
|
||||||
|
import com.competition.common.enums.ErrorCode;
|
||||||
|
import com.competition.common.result.Result;
|
||||||
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.http.HttpStatus;
|
||||||
|
import org.springframework.security.access.AccessDeniedException;
|
||||||
|
import org.springframework.security.core.AuthenticationException;
|
||||||
|
import org.springframework.validation.BindException;
|
||||||
|
import org.springframework.web.bind.MethodArgumentNotValidException;
|
||||||
|
import org.springframework.web.bind.annotation.ExceptionHandler;
|
||||||
|
import org.springframework.web.bind.annotation.ResponseStatus;
|
||||||
|
import org.springframework.web.bind.annotation.RestControllerAdvice;
|
||||||
|
import org.springframework.web.servlet.resource.NoResourceFoundException;
|
||||||
|
|
||||||
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 全局异常处理器
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@RestControllerAdvice
|
||||||
|
public class GlobalExceptionHandler {
|
||||||
|
|
||||||
|
/** 业务异常 */
|
||||||
|
@ExceptionHandler(BusinessException.class)
|
||||||
|
public Result<Void> handleBusinessException(BusinessException e, HttpServletRequest request) {
|
||||||
|
log.warn("业务异常,路径:{},消息:{}", request.getRequestURI(), e.getMessage());
|
||||||
|
return Result.error(e.getCode(), e.getMessage(), request.getRequestURI());
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 参数校验异常(@Valid) */
|
||||||
|
@ExceptionHandler(MethodArgumentNotValidException.class)
|
||||||
|
@ResponseStatus(HttpStatus.BAD_REQUEST)
|
||||||
|
public Result<Void> handleValidationException(MethodArgumentNotValidException e, HttpServletRequest request) {
|
||||||
|
String message = e.getBindingResult().getFieldErrors().stream()
|
||||||
|
.map(error -> error.getField() + ": " + error.getDefaultMessage())
|
||||||
|
.collect(Collectors.joining(", "));
|
||||||
|
log.warn("参数校验失败,路径:{},消息:{}", request.getRequestURI(), message);
|
||||||
|
return Result.error(400, message, request.getRequestURI());
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 参数绑定异常 */
|
||||||
|
@ExceptionHandler(BindException.class)
|
||||||
|
@ResponseStatus(HttpStatus.BAD_REQUEST)
|
||||||
|
public Result<Void> handleBindException(BindException e, HttpServletRequest request) {
|
||||||
|
String message = e.getFieldErrors().stream()
|
||||||
|
.map(error -> error.getField() + ": " + error.getDefaultMessage())
|
||||||
|
.collect(Collectors.joining(", "));
|
||||||
|
log.warn("参数绑定失败,路径:{},消息:{}", request.getRequestURI(), message);
|
||||||
|
return Result.error(400, message, request.getRequestURI());
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 认证异常 */
|
||||||
|
@ExceptionHandler(AuthenticationException.class)
|
||||||
|
@ResponseStatus(HttpStatus.UNAUTHORIZED)
|
||||||
|
public Result<Void> handleAuthenticationException(AuthenticationException e, HttpServletRequest request) {
|
||||||
|
return Result.error(401, ErrorCode.UNAUTHORIZED.getMessage(), request.getRequestURI());
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 授权异常 */
|
||||||
|
@ExceptionHandler(AccessDeniedException.class)
|
||||||
|
@ResponseStatus(HttpStatus.FORBIDDEN)
|
||||||
|
public Result<Void> handleAccessDeniedException(AccessDeniedException e, HttpServletRequest request) {
|
||||||
|
return Result.error(403, ErrorCode.FORBIDDEN.getMessage(), request.getRequestURI());
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 资源不存在 */
|
||||||
|
@ExceptionHandler(NoResourceFoundException.class)
|
||||||
|
@ResponseStatus(HttpStatus.NOT_FOUND)
|
||||||
|
public Result<Void> handleNotFoundException(NoResourceFoundException e, HttpServletRequest request) {
|
||||||
|
return Result.error(404, ErrorCode.NOT_FOUND.getMessage(), request.getRequestURI());
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 兜底:未知异常 */
|
||||||
|
@ExceptionHandler(Exception.class)
|
||||||
|
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
|
||||||
|
public Result<Void> handleException(Exception e, HttpServletRequest request) {
|
||||||
|
log.error("系统异常,路径:{},消息:{}", request.getRequestURI(), e.getMessage(), e);
|
||||||
|
return Result.error(500, ErrorCode.INTERNAL_ERROR.getMessage(), request.getRequestURI());
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,57 @@
|
|||||||
|
package com.competition.common.handler;
|
||||||
|
|
||||||
|
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
|
||||||
|
import com.competition.common.util.SecurityUtil;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.apache.ibatis.reflection.MetaObject;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
|
||||||
|
import java.time.LocalDateTime;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* MyBatis-Plus 审计字段自动填充
|
||||||
|
* 同时填充新字段(create_by/update_by/deleted)和旧字段(creator/modifier/valid_state)
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@Component
|
||||||
|
public class AuditMetaObjectHandler implements MetaObjectHandler {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void insertFill(MetaObject metaObject) {
|
||||||
|
LocalDateTime now = LocalDateTime.now();
|
||||||
|
String username = SecurityUtil.getCurrentUsername();
|
||||||
|
Long userId = SecurityUtil.getCurrentUserIdOrNull();
|
||||||
|
|
||||||
|
// 新审计字段
|
||||||
|
this.strictInsertFill(metaObject, "createBy", String.class, username);
|
||||||
|
this.strictInsertFill(metaObject, "updateBy", String.class, username);
|
||||||
|
this.strictInsertFill(metaObject, "deleted", Integer.class, 0);
|
||||||
|
|
||||||
|
// 旧审计字段
|
||||||
|
this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, now);
|
||||||
|
this.strictInsertFill(metaObject, "modifyTime", LocalDateTime.class, now);
|
||||||
|
this.strictInsertFill(metaObject, "validState", Integer.class, 1);
|
||||||
|
|
||||||
|
if (userId != null) {
|
||||||
|
this.strictInsertFill(metaObject, "creator", Integer.class, userId.intValue());
|
||||||
|
this.strictInsertFill(metaObject, "modifier", Integer.class, userId.intValue());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void updateFill(MetaObject metaObject) {
|
||||||
|
LocalDateTime now = LocalDateTime.now();
|
||||||
|
String username = SecurityUtil.getCurrentUsername();
|
||||||
|
Long userId = SecurityUtil.getCurrentUserIdOrNull();
|
||||||
|
|
||||||
|
// 新审计字段
|
||||||
|
this.strictUpdateFill(metaObject, "updateBy", String.class, username);
|
||||||
|
|
||||||
|
// 旧审计字段
|
||||||
|
this.strictUpdateFill(metaObject, "modifyTime", LocalDateTime.class, now);
|
||||||
|
|
||||||
|
if (userId != null) {
|
||||||
|
this.strictUpdateFill(metaObject, "modifier", Integer.class, userId.intValue());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,101 @@
|
|||||||
|
package com.competition.common.interceptor;
|
||||||
|
|
||||||
|
import com.competition.common.annotation.RateLimit;
|
||||||
|
import com.competition.common.result.Result;
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
|
import jakarta.servlet.http.HttpServletResponse;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.data.redis.core.StringRedisTemplate;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
import org.springframework.web.method.HandlerMethod;
|
||||||
|
import org.springframework.web.servlet.HandlerInterceptor;
|
||||||
|
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 速率限制拦截器
|
||||||
|
* 基于 Redis 实现滑动窗口限流
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@Component
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class RateLimitInterceptor implements HandlerInterceptor {
|
||||||
|
|
||||||
|
private final StringRedisTemplate redisTemplate;
|
||||||
|
private final ObjectMapper objectMapper;
|
||||||
|
|
||||||
|
private static final String RATE_LIMIT_PREFIX = "rate_limit:";
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
|
||||||
|
if (!(handler instanceof HandlerMethod handlerMethod)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
RateLimit rateLimit = handlerMethod.getMethodAnnotation(RateLimit.class);
|
||||||
|
if (rateLimit == null) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
String key = buildKey(request, rateLimit);
|
||||||
|
String redisKey = RATE_LIMIT_PREFIX + key;
|
||||||
|
|
||||||
|
// 获取当前计数
|
||||||
|
String countStr = redisTemplate.opsForValue().get(redisKey);
|
||||||
|
long currentCount = countStr != null ? Long.parseLong(countStr) : 0;
|
||||||
|
|
||||||
|
if (currentCount >= rateLimit.permits()) {
|
||||||
|
log.warn("接口速率限制触发:key={},已请求 {} 次,限制 {} 次", key, currentCount, rateLimit.permits());
|
||||||
|
response.setContentType("application/json;charset=UTF-8");
|
||||||
|
response.setStatus(429);
|
||||||
|
response.getWriter().write(objectMapper.writeValueAsString(
|
||||||
|
Result.error(429, "请求过于频繁,请稍后再试")));
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 增加计数
|
||||||
|
Long newCount = redisTemplate.opsForValue().increment(redisKey);
|
||||||
|
if (newCount != null && newCount == 1) {
|
||||||
|
// 首次请求,设置过期时间
|
||||||
|
redisTemplate.expire(redisKey, rateLimit.duration(), rateLimit.timeUnit());
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 构建限流 key
|
||||||
|
*/
|
||||||
|
private String buildKey(HttpServletRequest request, RateLimit rateLimit) {
|
||||||
|
String identity;
|
||||||
|
if ("user".equals(rateLimit.key())) {
|
||||||
|
// 基于 User-ID(需要认证后才有)
|
||||||
|
identity = request.getHeader("X-User-Id");
|
||||||
|
if (identity == null) identity = request.getRemoteAddr();
|
||||||
|
} else {
|
||||||
|
// 基于 IP
|
||||||
|
identity = getClientIp(request);
|
||||||
|
}
|
||||||
|
return request.getMethod() + ":" + request.getRequestURI() + ":" + identity;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取客户端真实 IP
|
||||||
|
*/
|
||||||
|
private String getClientIp(HttpServletRequest request) {
|
||||||
|
String ip = request.getHeader("X-Forwarded-For");
|
||||||
|
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
||||||
|
ip = request.getHeader("X-Real-IP");
|
||||||
|
}
|
||||||
|
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
||||||
|
ip = request.getRemoteAddr();
|
||||||
|
}
|
||||||
|
// 多级代理取第一个
|
||||||
|
if (ip != null && ip.contains(",")) {
|
||||||
|
ip = ip.split(",")[0].trim();
|
||||||
|
}
|
||||||
|
return ip;
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,33 @@
|
|||||||
|
package com.competition.common.interceptor;
|
||||||
|
|
||||||
|
import cn.hutool.core.util.IdUtil;
|
||||||
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
|
import jakarta.servlet.http.HttpServletResponse;
|
||||||
|
import org.slf4j.MDC;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
import org.springframework.web.servlet.HandlerInterceptor;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TraceId 链路追踪拦截器
|
||||||
|
*/
|
||||||
|
@Component
|
||||||
|
public class TraceIdInterceptor implements HandlerInterceptor {
|
||||||
|
|
||||||
|
private static final String TRACE_ID = "traceId";
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
|
||||||
|
String traceId = request.getHeader("X-Trace-Id");
|
||||||
|
if (traceId == null || traceId.isBlank()) {
|
||||||
|
traceId = IdUtil.fastSimpleUUID();
|
||||||
|
}
|
||||||
|
MDC.put(TRACE_ID, traceId);
|
||||||
|
response.setHeader("X-Trace-Id", traceId);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
|
||||||
|
MDC.remove(TRACE_ID);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,60 @@
|
|||||||
|
package com.competition.common.result;
|
||||||
|
|
||||||
|
import com.baomidou.mybatisplus.core.metadata.IPage;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
import java.io.Serializable;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 分页结果,格式与前端完全兼容:{ list, total, page, pageSize }
|
||||||
|
*/
|
||||||
|
@Data
|
||||||
|
public class PageResult<T> implements Serializable {
|
||||||
|
|
||||||
|
/** 数据列表 */
|
||||||
|
private List<T> list;
|
||||||
|
|
||||||
|
/** 总记录数 */
|
||||||
|
private Long total;
|
||||||
|
|
||||||
|
/** 当前页码 */
|
||||||
|
private Long page;
|
||||||
|
|
||||||
|
/** 每页大小 */
|
||||||
|
private Long pageSize;
|
||||||
|
|
||||||
|
public PageResult() {
|
||||||
|
}
|
||||||
|
|
||||||
|
public PageResult(List<T> list, Long total, Long page, Long pageSize) {
|
||||||
|
this.list = list;
|
||||||
|
this.total = total;
|
||||||
|
this.page = page;
|
||||||
|
this.pageSize = pageSize;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 从 MyBatis-Plus 的 IPage 转换
|
||||||
|
*/
|
||||||
|
public static <T> PageResult<T> from(IPage<T> page) {
|
||||||
|
return new PageResult<>(
|
||||||
|
page.getRecords(),
|
||||||
|
page.getTotal(),
|
||||||
|
page.getCurrent(),
|
||||||
|
page.getSize()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 从 MyBatis-Plus 的 IPage 转换,支持 VO 列表替换
|
||||||
|
*/
|
||||||
|
public static <T> PageResult<T> from(IPage<?> page, List<T> voList) {
|
||||||
|
return new PageResult<>(
|
||||||
|
voList,
|
||||||
|
page.getTotal(),
|
||||||
|
page.getCurrent(),
|
||||||
|
page.getSize()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,62 @@
|
|||||||
|
package com.competition.common.result;
|
||||||
|
|
||||||
|
import com.competition.common.enums.ErrorCode;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
import java.io.Serializable;
|
||||||
|
import java.time.LocalDateTime;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 统一响应结果
|
||||||
|
* 格式与 NestJS 前端完全兼容:{ code, message, data, timestamp, path }
|
||||||
|
*/
|
||||||
|
@Data
|
||||||
|
public class Result<T> implements Serializable {
|
||||||
|
|
||||||
|
private Integer code;
|
||||||
|
private String message;
|
||||||
|
private T data;
|
||||||
|
private String timestamp;
|
||||||
|
private String path;
|
||||||
|
|
||||||
|
private Result() {
|
||||||
|
}
|
||||||
|
|
||||||
|
public static <T> Result<T> success(T data) {
|
||||||
|
Result<T> result = new Result<>();
|
||||||
|
result.setCode(200);
|
||||||
|
result.setMessage("success");
|
||||||
|
result.setData(data);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static <T> Result<T> success() {
|
||||||
|
return success(null);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static <T> Result<T> success(String message, T data) {
|
||||||
|
Result<T> result = new Result<>();
|
||||||
|
result.setCode(200);
|
||||||
|
result.setMessage(message);
|
||||||
|
result.setData(data);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static <T> Result<T> error(Integer code, String message) {
|
||||||
|
Result<T> result = new Result<>();
|
||||||
|
result.setCode(code);
|
||||||
|
result.setMessage(message);
|
||||||
|
result.setTimestamp(LocalDateTime.now().toString());
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static <T> Result<T> error(ErrorCode errorCode) {
|
||||||
|
return error(errorCode.getCode(), errorCode.getMessage());
|
||||||
|
}
|
||||||
|
|
||||||
|
public static <T> Result<T> error(Integer code, String message, String path) {
|
||||||
|
Result<T> result = error(code, message);
|
||||||
|
result.setPath(path);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,68 @@
|
|||||||
|
package com.competition.common.util;
|
||||||
|
|
||||||
|
import com.competition.security.model.LoginUser;
|
||||||
|
import org.springframework.security.core.Authentication;
|
||||||
|
import org.springframework.security.core.context.SecurityContextHolder;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 安全工具类 - 获取当前登录用户信息
|
||||||
|
*/
|
||||||
|
public final class SecurityUtil {
|
||||||
|
|
||||||
|
private SecurityUtil() {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取当前登录用户
|
||||||
|
*/
|
||||||
|
public static LoginUser getCurrentUser() {
|
||||||
|
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
|
||||||
|
if (authentication != null && authentication.getPrincipal() instanceof LoginUser loginUser) {
|
||||||
|
return loginUser;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取当前用户 ID(未登录返回 null)
|
||||||
|
*/
|
||||||
|
public static Long getCurrentUserIdOrNull() {
|
||||||
|
LoginUser user = getCurrentUser();
|
||||||
|
return user != null ? user.getUserId() : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取当前用户 ID(未登录抛异常)
|
||||||
|
*/
|
||||||
|
public static Long getCurrentUserId() {
|
||||||
|
LoginUser user = getCurrentUser();
|
||||||
|
if (user == null) {
|
||||||
|
throw new RuntimeException("用户未登录");
|
||||||
|
}
|
||||||
|
return user.getUserId();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取当前用户名(未登录返回 "system")
|
||||||
|
*/
|
||||||
|
public static String getCurrentUsername() {
|
||||||
|
LoginUser user = getCurrentUser();
|
||||||
|
return user != null ? user.getUsername() : "system";
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取当前租户 ID(未登录返回 null)
|
||||||
|
*/
|
||||||
|
public static Long getCurrentTenantId() {
|
||||||
|
LoginUser user = getCurrentUser();
|
||||||
|
return user != null ? user.getTenantId() : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 当前用户是否为超级管理员
|
||||||
|
*/
|
||||||
|
public static boolean isSuperAdmin() {
|
||||||
|
LoginUser user = getCurrentUser();
|
||||||
|
return user != null && user.isSuperAdmin();
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,51 @@
|
|||||||
|
package com.competition.common.util;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 敏感信息脱敏工具类
|
||||||
|
* 用于日志输出时对手机号、身份证号、Token 等进行脱敏处理
|
||||||
|
*/
|
||||||
|
public final class SensitiveUtil {
|
||||||
|
|
||||||
|
private SensitiveUtil() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 手机号脱敏:保留前3位和后4位
|
||||||
|
* 例:13812345678 → 138****5678
|
||||||
|
*/
|
||||||
|
public static String phone(String phone) {
|
||||||
|
if (phone == null || phone.length() < 7) {
|
||||||
|
return "***";
|
||||||
|
}
|
||||||
|
return phone.substring(0, 3) + "****" + phone.substring(phone.length() - 4);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Token 脱敏:只显示前8位和后4位
|
||||||
|
* 例:eyJhbGciOi...xyz → eyJhbGci...xyz
|
||||||
|
*/
|
||||||
|
public static String token(String token) {
|
||||||
|
if (token == null || token.length() < 12) {
|
||||||
|
return "***";
|
||||||
|
}
|
||||||
|
return token.substring(0, 8) + "..." + token.substring(token.length() - 4);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 身份证号脱敏:保留前3位和后4位
|
||||||
|
*/
|
||||||
|
public static String idCard(String idCard) {
|
||||||
|
if (idCard == null || idCard.length() < 7) {
|
||||||
|
return "***";
|
||||||
|
}
|
||||||
|
return idCard.substring(0, 3) + "***********" + idCard.substring(idCard.length() - 4);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 通用脱敏:只显示前后各 n 位
|
||||||
|
*/
|
||||||
|
public static String mask(String value, int keepChars) {
|
||||||
|
if (value == null) return "***";
|
||||||
|
if (value.length() <= keepChars * 2) return "***";
|
||||||
|
return value.substring(0, keepChars) + "***" + value.substring(value.length() - keepChars);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,65 @@
|
|||||||
|
package com.competition.modules.biz.contest.controller;
|
||||||
|
|
||||||
|
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
|
||||||
|
import com.competition.common.result.Result;
|
||||||
|
import com.competition.modules.biz.contest.entity.BizContestAttachment;
|
||||||
|
import com.competition.modules.biz.contest.service.IContestAttachmentService;
|
||||||
|
import com.competition.security.annotation.RequirePermission;
|
||||||
|
import io.swagger.v3.oas.annotations.Operation;
|
||||||
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import org.springframework.web.bind.annotation.*;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@Tag(name = "活动附件")
|
||||||
|
@RestController
|
||||||
|
@RequestMapping("/contests/attachments")
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class ContestAttachmentController {
|
||||||
|
|
||||||
|
private final IContestAttachmentService attachmentService;
|
||||||
|
|
||||||
|
@PostMapping
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "上传附件")
|
||||||
|
public Result<BizContestAttachment> create(@RequestBody BizContestAttachment attachment) {
|
||||||
|
attachmentService.save(attachment);
|
||||||
|
return Result.success(attachment);
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/contest/{contestId}")
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "查询活动下的附件列表")
|
||||||
|
public Result<List<BizContestAttachment>> findByContest(@PathVariable Long contestId) {
|
||||||
|
List<BizContestAttachment> list = attachmentService.list(
|
||||||
|
new LambdaQueryWrapper<BizContestAttachment>()
|
||||||
|
.eq(BizContestAttachment::getContestId, contestId)
|
||||||
|
.orderByDesc(BizContestAttachment::getCreateTime));
|
||||||
|
return Result.success(list);
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/{id}")
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "查询附件详情")
|
||||||
|
public Result<BizContestAttachment> findDetail(@PathVariable Long id) {
|
||||||
|
return Result.success(attachmentService.getById(id));
|
||||||
|
}
|
||||||
|
|
||||||
|
@PatchMapping("/{id}")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "更新附件")
|
||||||
|
public Result<Void> update(@PathVariable Long id, @RequestBody BizContestAttachment attachment) {
|
||||||
|
attachment.setId(id);
|
||||||
|
attachmentService.updateById(attachment);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@DeleteMapping("/{id}")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "删除附件")
|
||||||
|
public Result<Void> remove(@PathVariable Long id) {
|
||||||
|
attachmentService.removeById(id);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,115 @@
|
|||||||
|
package com.competition.modules.biz.contest.controller;
|
||||||
|
|
||||||
|
import com.competition.common.result.PageResult;
|
||||||
|
import com.competition.common.result.Result;
|
||||||
|
import com.competition.common.util.SecurityUtil;
|
||||||
|
import com.competition.modules.biz.contest.dto.CreateContestDto;
|
||||||
|
import com.competition.modules.biz.contest.dto.QueryContestDto;
|
||||||
|
import com.competition.modules.biz.contest.entity.BizContest;
|
||||||
|
import com.competition.modules.biz.contest.service.IContestService;
|
||||||
|
import com.competition.modules.sys.service.ISysTenantService;
|
||||||
|
import com.competition.security.annotation.RequirePermission;
|
||||||
|
import io.swagger.v3.oas.annotations.Operation;
|
||||||
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||||
|
import jakarta.validation.Valid;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import org.springframework.web.bind.annotation.*;
|
||||||
|
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
@Tag(name = "活动管理")
|
||||||
|
@RestController
|
||||||
|
@RequestMapping("/contests")
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class ContestController {
|
||||||
|
|
||||||
|
private final IContestService contestService;
|
||||||
|
private final ISysTenantService tenantService;
|
||||||
|
|
||||||
|
@PostMapping
|
||||||
|
@RequirePermission("contest:create")
|
||||||
|
@Operation(summary = "创建活动")
|
||||||
|
public Result<BizContest> create(@Valid @RequestBody CreateContestDto dto) {
|
||||||
|
return Result.success(contestService.createContest(dto, SecurityUtil.getCurrentUserId()));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/stats")
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "获取活动统计")
|
||||||
|
public Result<Map<String, Object>> getStats() {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
boolean isSuperTenant = tenantService.isSuperTenant(tenantId);
|
||||||
|
return Result.success(contestService.getStats(tenantId, isSuperTenant));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/dashboard")
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "获取活动看板")
|
||||||
|
public Result<Map<String, Object>> getDashboard() {
|
||||||
|
return Result.success(contestService.getDashboard(SecurityUtil.getCurrentTenantId()));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "查询活动列表")
|
||||||
|
public Result<PageResult<Map<String, Object>>> findAll(QueryContestDto dto) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
boolean isSuperTenant = tenantService.isSuperTenant(tenantId);
|
||||||
|
return Result.success(contestService.findAll(dto, tenantId, isSuperTenant));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/my-contests")
|
||||||
|
@RequirePermission({"contest:read", "contest:activity:read"})
|
||||||
|
@Operation(summary = "获取我的活动")
|
||||||
|
public Result<PageResult<Map<String, Object>>> getMyContests(QueryContestDto dto) {
|
||||||
|
Long userId = SecurityUtil.getCurrentUserId();
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
return Result.success(contestService.getMyContests(dto, userId, tenantId));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/{id}")
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "查询活动详情")
|
||||||
|
public Result<Map<String, Object>> findDetail(@PathVariable Long id) {
|
||||||
|
return Result.success(contestService.findDetail(id));
|
||||||
|
}
|
||||||
|
|
||||||
|
@PatchMapping("/{id}")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "更新活动")
|
||||||
|
public Result<BizContest> update(@PathVariable Long id, @RequestBody CreateContestDto dto) {
|
||||||
|
return Result.success(contestService.updateContest(id, dto));
|
||||||
|
}
|
||||||
|
|
||||||
|
@PatchMapping("/{id}/publish")
|
||||||
|
@RequirePermission("contest:publish")
|
||||||
|
@Operation(summary = "发布/撤回活动")
|
||||||
|
public Result<Void> publish(@PathVariable Long id, @RequestBody Map<String, String> body) {
|
||||||
|
contestService.publishContest(id, body.get("contestState"));
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@PatchMapping("/{id}/finish")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "结束活动")
|
||||||
|
public Result<Void> finish(@PathVariable Long id) {
|
||||||
|
contestService.finishContest(id);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@PatchMapping("/{id}/reopen")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "重新开放活动")
|
||||||
|
public Result<Void> reopen(@PathVariable Long id) {
|
||||||
|
contestService.reopenContest(id);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@DeleteMapping("/{id}")
|
||||||
|
@RequirePermission("contest:delete")
|
||||||
|
@Operation(summary = "删除活动")
|
||||||
|
public Result<Void> remove(@PathVariable Long id) {
|
||||||
|
contestService.removeContest(id);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,217 @@
|
|||||||
|
package com.competition.modules.biz.contest.controller;
|
||||||
|
|
||||||
|
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
|
||||||
|
import com.baomidou.mybatisplus.core.conditions.update.LambdaUpdateWrapper;
|
||||||
|
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
|
||||||
|
import com.competition.common.enums.ErrorCode;
|
||||||
|
import com.competition.common.enums.PublishStatus;
|
||||||
|
import com.competition.common.exception.BusinessException;
|
||||||
|
import com.competition.common.result.PageResult;
|
||||||
|
import com.competition.common.result.Result;
|
||||||
|
import com.competition.common.util.SecurityUtil;
|
||||||
|
import com.competition.modules.biz.contest.dto.CreateNoticeDto;
|
||||||
|
import com.competition.modules.biz.contest.entity.BizContestNotice;
|
||||||
|
import com.competition.modules.biz.contest.service.IContestNoticeService;
|
||||||
|
import com.competition.security.annotation.RequirePermission;
|
||||||
|
import io.swagger.v3.oas.annotations.Operation;
|
||||||
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||||
|
import jakarta.validation.Valid;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import org.springframework.util.StringUtils;
|
||||||
|
import org.springframework.web.bind.annotation.*;
|
||||||
|
|
||||||
|
import java.time.LocalDateTime;
|
||||||
|
import java.time.format.DateTimeFormatter;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
@Tag(name = "活动公告")
|
||||||
|
@RestController
|
||||||
|
@RequestMapping("/contests/notices")
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class ContestNoticeController {
|
||||||
|
|
||||||
|
private final IContestNoticeService noticeService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 解析日期时间字符串,兼容 ISO 格式(带毫秒和 Z 时区标记)
|
||||||
|
*/
|
||||||
|
private LocalDateTime parseDateTime(String dateTime) {
|
||||||
|
if (!StringUtils.hasText(dateTime)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
// 尝试 ISO 格式(yyyy-MM-dd'T'HH:mm:ss.SSSZ 或 yyyy-MM-dd'T'HH:mm:ss'Z')
|
||||||
|
try {
|
||||||
|
// 处理带 Z 的 ISO 格式
|
||||||
|
if (dateTime.endsWith("Z")) {
|
||||||
|
return LocalDateTime.parse(dateTime.substring(0, dateTime.length() - 1));
|
||||||
|
}
|
||||||
|
// 处理带毫秒的格式
|
||||||
|
if (dateTime.contains(".") && dateTime.indexOf(".") + 4 == dateTime.length()) {
|
||||||
|
return LocalDateTime.parse(dateTime.substring(0, dateTime.indexOf(".")));
|
||||||
|
}
|
||||||
|
return LocalDateTime.parse(dateTime);
|
||||||
|
} catch (Exception e) {
|
||||||
|
// 尝试空格分隔格式
|
||||||
|
try {
|
||||||
|
return LocalDateTime.parse(dateTime, DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
|
||||||
|
} catch (Exception ex) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@PostMapping
|
||||||
|
@RequirePermission("notice:create")
|
||||||
|
@Operation(summary = "创建公告")
|
||||||
|
public Result<BizContestNotice> create(@Valid @RequestBody CreateNoticeDto dto) {
|
||||||
|
BizContestNotice notice = new BizContestNotice();
|
||||||
|
notice.setContestId(dto.getContestId());
|
||||||
|
notice.setTitle(dto.getTitle());
|
||||||
|
notice.setContent(dto.getContent());
|
||||||
|
notice.setNoticeType(dto.getNoticeType());
|
||||||
|
notice.setPriority(dto.getPriority());
|
||||||
|
if (StringUtils.hasText(dto.getPublishTime())) {
|
||||||
|
notice.setPublishTime(parseDateTime(dto.getPublishTime()));
|
||||||
|
}
|
||||||
|
// 设置当前租户 ID(租户隔离)
|
||||||
|
notice.setTenantId(SecurityUtil.getCurrentTenantId());
|
||||||
|
noticeService.save(notice);
|
||||||
|
return Result.success(notice);
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/contest/{contestId}")
|
||||||
|
@RequirePermission("notice:read")
|
||||||
|
@Operation(summary = "查询活动下的公告列表")
|
||||||
|
public Result<List<BizContestNotice>> findByContest(@PathVariable Long contestId) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
List<BizContestNotice> list = noticeService.list(
|
||||||
|
new LambdaQueryWrapper<BizContestNotice>()
|
||||||
|
.eq(BizContestNotice::getContestId, contestId)
|
||||||
|
.eq(BizContestNotice::getTenantId, tenantId)
|
||||||
|
.orderByDesc(BizContestNotice::getCreateTime));
|
||||||
|
noticeService.fillContestInfo(list);
|
||||||
|
return Result.success(list);
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping
|
||||||
|
@RequirePermission("notice:read")
|
||||||
|
@Operation(summary = "分页查询公告列表")
|
||||||
|
public Result<PageResult<BizContestNotice>> findAll(
|
||||||
|
@RequestParam(defaultValue = "1") Long page,
|
||||||
|
@RequestParam(defaultValue = "10") Long pageSize,
|
||||||
|
@RequestParam(required = false) String title,
|
||||||
|
@RequestParam(required = false) String status) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
LambdaQueryWrapper<BizContestNotice> wrapper = new LambdaQueryWrapper<BizContestNotice>()
|
||||||
|
.eq(BizContestNotice::getTenantId, tenantId) // 租户隔离
|
||||||
|
.like(StringUtils.hasText(title), BizContestNotice::getTitle, title);
|
||||||
|
|
||||||
|
// 发布状态过滤
|
||||||
|
if (PublishStatus.PUBLISHED.getValue().equals(status)) {
|
||||||
|
wrapper.isNotNull(BizContestNotice::getPublishTime);
|
||||||
|
} else if (PublishStatus.UNPUBLISHED.getValue().equals(status)) {
|
||||||
|
wrapper.isNull(BizContestNotice::getPublishTime);
|
||||||
|
}
|
||||||
|
|
||||||
|
wrapper.orderByDesc(BizContestNotice::getCreateTime);
|
||||||
|
Page<BizContestNotice> result = noticeService.page(new Page<>(page, pageSize), wrapper);
|
||||||
|
noticeService.fillContestInfo(result.getRecords());
|
||||||
|
return Result.success(PageResult.from(result));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/{id}")
|
||||||
|
@RequirePermission("notice:read")
|
||||||
|
@Operation(summary = "查询公告详情")
|
||||||
|
public Result<BizContestNotice> findDetail(@PathVariable Long id) {
|
||||||
|
BizContestNotice notice = noticeService.getById(id);
|
||||||
|
if (notice != null) {
|
||||||
|
noticeService.fillContestInfo(Collections.singletonList(notice));
|
||||||
|
}
|
||||||
|
return Result.success(notice);
|
||||||
|
}
|
||||||
|
|
||||||
|
@PatchMapping("/{id}")
|
||||||
|
@RequirePermission("notice:update")
|
||||||
|
@Operation(summary = "更新公告(部分字段;publishTime 为 null 或空串表示取消发布并写入数据库 NULL)")
|
||||||
|
public Result<Void> update(@PathVariable Long id, @RequestBody Map<String, Object> body) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
BizContestNotice existing = noticeService.getOne(
|
||||||
|
new LambdaQueryWrapper<BizContestNotice>()
|
||||||
|
.eq(BizContestNotice::getId, id)
|
||||||
|
.eq(BizContestNotice::getTenantId, tenantId));
|
||||||
|
if (existing == null) {
|
||||||
|
throw BusinessException.of(ErrorCode.NOT_FOUND, "公告不存在");
|
||||||
|
}
|
||||||
|
|
||||||
|
LambdaUpdateWrapper<BizContestNotice> uw = new LambdaUpdateWrapper<>();
|
||||||
|
uw.eq(BizContestNotice::getId, id);
|
||||||
|
uw.eq(BizContestNotice::getTenantId, tenantId);
|
||||||
|
|
||||||
|
boolean hasUpdate = false;
|
||||||
|
if (body.containsKey("title")) {
|
||||||
|
Object v = body.get("title");
|
||||||
|
if (v != null) {
|
||||||
|
uw.set(BizContestNotice::getTitle, String.valueOf(v));
|
||||||
|
hasUpdate = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (body.containsKey("content")) {
|
||||||
|
Object v = body.get("content");
|
||||||
|
if (v != null) {
|
||||||
|
uw.set(BizContestNotice::getContent, String.valueOf(v));
|
||||||
|
hasUpdate = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (body.containsKey("noticeType")) {
|
||||||
|
Object v = body.get("noticeType");
|
||||||
|
if (v != null) {
|
||||||
|
uw.set(BizContestNotice::getNoticeType, String.valueOf(v));
|
||||||
|
hasUpdate = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (body.containsKey("priority")) {
|
||||||
|
Object v = body.get("priority");
|
||||||
|
if (v instanceof Number) {
|
||||||
|
uw.set(BizContestNotice::getPriority, ((Number) v).intValue());
|
||||||
|
hasUpdate = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (body.containsKey("contestId")) {
|
||||||
|
Object v = body.get("contestId");
|
||||||
|
if (v instanceof Number) {
|
||||||
|
uw.set(BizContestNotice::getContestId, ((Number) v).longValue());
|
||||||
|
hasUpdate = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// 仅当请求体包含 publishTime 键时才改发布时间:null / 空串 = 取消发布(必须写入 SQL NULL)
|
||||||
|
if (body.containsKey("publishTime")) {
|
||||||
|
Object v = body.get("publishTime");
|
||||||
|
if (v == null || (v instanceof String && !StringUtils.hasText((String) v))) {
|
||||||
|
uw.set(BizContestNotice::getPublishTime, null);
|
||||||
|
hasUpdate = true;
|
||||||
|
} else if (v instanceof String && StringUtils.hasText((String) v)) {
|
||||||
|
LocalDateTime pt = parseDateTime((String) v);
|
||||||
|
if (pt != null) {
|
||||||
|
uw.set(BizContestNotice::getPublishTime, pt);
|
||||||
|
hasUpdate = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!hasUpdate) {
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
noticeService.getBaseMapper().update(null, uw);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@DeleteMapping("/{id}")
|
||||||
|
@RequirePermission("notice:delete")
|
||||||
|
@Operation(summary = "删除公告")
|
||||||
|
public Result<Void> remove(@PathVariable Long id) {
|
||||||
|
noticeService.removeById(id);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,127 @@
|
|||||||
|
package com.competition.modules.biz.contest.controller;
|
||||||
|
|
||||||
|
import com.competition.common.result.PageResult;
|
||||||
|
import com.competition.common.result.Result;
|
||||||
|
import com.competition.common.util.SecurityUtil;
|
||||||
|
import com.competition.modules.biz.contest.dto.CreateRegistrationDto;
|
||||||
|
import com.competition.modules.biz.contest.dto.QueryRegistrationDto;
|
||||||
|
import com.competition.modules.biz.contest.service.IContestRegistrationService;
|
||||||
|
import com.competition.security.annotation.RequirePermission;
|
||||||
|
import io.swagger.v3.oas.annotations.Operation;
|
||||||
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||||
|
import jakarta.validation.Valid;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import org.springframework.web.bind.annotation.*;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
@Tag(name = "报名管理")
|
||||||
|
@RestController
|
||||||
|
@RequestMapping("/contests/registrations")
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class ContestRegistrationController {
|
||||||
|
|
||||||
|
private final IContestRegistrationService registrationService;
|
||||||
|
|
||||||
|
@PostMapping
|
||||||
|
@RequirePermission("contest:register")
|
||||||
|
@Operation(summary = "创建报名")
|
||||||
|
public Result<Map<String, Object>> create(@Valid @RequestBody CreateRegistrationDto dto) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
Long userId = SecurityUtil.getCurrentUserId();
|
||||||
|
return Result.success(registrationService.createRegistration(dto, tenantId, userId));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/stats")
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "获取报名统计")
|
||||||
|
public Result<Map<String, Object>> getStats(@RequestParam(required = false) Long contestId) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
boolean isSuperAdmin = SecurityUtil.isSuperAdmin();
|
||||||
|
return Result.success(registrationService.getStats(contestId, tenantId, isSuperAdmin));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "查询报名列表")
|
||||||
|
public Result<PageResult<Map<String, Object>>> findAll(QueryRegistrationDto dto) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
boolean isSuperTenant = SecurityUtil.isSuperAdmin();
|
||||||
|
return Result.success(registrationService.findAll(dto, tenantId, isSuperTenant));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/my/{contestId}")
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "获取我的报名信息")
|
||||||
|
public Result<Map<String, Object>> getMyRegistration(@PathVariable Long contestId) {
|
||||||
|
Long userId = SecurityUtil.getCurrentUserId();
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
return Result.success(registrationService.getMyRegistration(contestId, userId, tenantId));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/{id}")
|
||||||
|
@RequirePermission("contest:read")
|
||||||
|
@Operation(summary = "查询报名详情")
|
||||||
|
public Result<Map<String, Object>> findDetail(@PathVariable Long id) {
|
||||||
|
return Result.success(registrationService.findDetail(id, SecurityUtil.getCurrentTenantId()));
|
||||||
|
}
|
||||||
|
|
||||||
|
@PatchMapping("/{id}/review")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "审核报名")
|
||||||
|
public Result<Void> review(@PathVariable Long id, @RequestBody Map<String, String> body) {
|
||||||
|
Long operatorId = SecurityUtil.getCurrentUserId();
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
registrationService.reviewRegistration(id, body.get("registrationState"), body.get("reason"), operatorId, tenantId);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@PatchMapping("/{id}/revoke")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "撤回审核")
|
||||||
|
public Result<Void> revoke(@PathVariable Long id) {
|
||||||
|
registrationService.revokeReview(id, SecurityUtil.getCurrentTenantId());
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@PostMapping("/batch-review")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "批量审核报名")
|
||||||
|
@SuppressWarnings("unchecked")
|
||||||
|
public Result<Void> batchReview(@RequestBody Map<String, Object> body) {
|
||||||
|
List<Long> ids = (List<Long>) body.get("ids");
|
||||||
|
String registrationState = (String) body.get("registrationState");
|
||||||
|
String reason = (String) body.get("reason");
|
||||||
|
Long operatorId = SecurityUtil.getCurrentUserId();
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
registrationService.batchReview(ids, registrationState, reason, operatorId, tenantId);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@PostMapping("/{id}/teachers")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "添加指导老师")
|
||||||
|
public Result<Void> addTeacher(@PathVariable Long id, @RequestBody Map<String, Long> body) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
Long creatorId = SecurityUtil.getCurrentUserId();
|
||||||
|
registrationService.addTeacher(id, body.get("teacherUserId"), tenantId, creatorId);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@DeleteMapping("/{id}/teachers/{teacherUserId}")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "移除指导老师")
|
||||||
|
public Result<Void> removeTeacher(@PathVariable Long id, @PathVariable Long teacherUserId) {
|
||||||
|
registrationService.removeTeacher(id, teacherUserId, SecurityUtil.getCurrentTenantId());
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@DeleteMapping("/{id}")
|
||||||
|
@RequirePermission("contest:update")
|
||||||
|
@Operation(summary = "删除报名")
|
||||||
|
public Result<Void> remove(@PathVariable Long id) {
|
||||||
|
registrationService.removeRegistration(id, SecurityUtil.getCurrentTenantId());
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,81 @@
|
|||||||
|
package com.competition.modules.biz.contest.controller;
|
||||||
|
|
||||||
|
import com.competition.common.result.Result;
|
||||||
|
import com.competition.common.util.SecurityUtil;
|
||||||
|
import com.competition.modules.biz.contest.dto.CreateTeamDto;
|
||||||
|
import com.competition.modules.biz.contest.entity.BizContestTeam;
|
||||||
|
import com.competition.modules.biz.contest.service.IContestTeamService;
|
||||||
|
import com.competition.security.annotation.RequirePermission;
|
||||||
|
import io.swagger.v3.oas.annotations.Operation;
|
||||||
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||||
|
import jakarta.validation.Valid;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import org.springframework.web.bind.annotation.*;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
@Tag(name = "团队管理")
|
||||||
|
@RestController
|
||||||
|
@RequestMapping("/contests/teams")
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class ContestTeamController {
|
||||||
|
|
||||||
|
private final IContestTeamService teamService;
|
||||||
|
|
||||||
|
@PostMapping
|
||||||
|
@RequirePermission("team:create")
|
||||||
|
@Operation(summary = "创建团队")
|
||||||
|
public Result<Map<String, Object>> create(@Valid @RequestBody CreateTeamDto dto) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
Long creatorId = SecurityUtil.getCurrentUserId();
|
||||||
|
return Result.success(teamService.createTeam(dto, tenantId, creatorId));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/contest/{contestId}")
|
||||||
|
@RequirePermission("team:read")
|
||||||
|
@Operation(summary = "查询活动下的团队列表")
|
||||||
|
public Result<List<Map<String, Object>>> findByContest(@PathVariable Long contestId) {
|
||||||
|
return Result.success(teamService.findByContest(contestId, SecurityUtil.getCurrentTenantId()));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/{id}")
|
||||||
|
@RequirePermission("team:read")
|
||||||
|
@Operation(summary = "查询团队详情")
|
||||||
|
public Result<Map<String, Object>> findDetail(@PathVariable Long id) {
|
||||||
|
return Result.success(teamService.findDetail(id));
|
||||||
|
}
|
||||||
|
|
||||||
|
@PatchMapping("/{id}")
|
||||||
|
@RequirePermission("team:update")
|
||||||
|
@Operation(summary = "更新团队")
|
||||||
|
public Result<BizContestTeam> update(@PathVariable Long id, @RequestBody CreateTeamDto dto) {
|
||||||
|
return Result.success(teamService.updateTeam(id, dto));
|
||||||
|
}
|
||||||
|
|
||||||
|
@PostMapping("/{id}/members")
|
||||||
|
@RequirePermission("team:update")
|
||||||
|
@Operation(summary = "添加团队成员")
|
||||||
|
public Result<Void> addMember(@PathVariable Long id, @RequestBody Map<String, Object> body) {
|
||||||
|
Long userId = ((Number) body.get("userId")).longValue();
|
||||||
|
String role = (String) body.get("role");
|
||||||
|
teamService.addMember(id, userId, role, SecurityUtil.getCurrentTenantId());
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@DeleteMapping("/{id}/members/{userId}")
|
||||||
|
@RequirePermission("team:update")
|
||||||
|
@Operation(summary = "移除团队成员")
|
||||||
|
public Result<Void> removeMember(@PathVariable Long id, @PathVariable Long userId) {
|
||||||
|
teamService.removeMember(id, userId);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
|
||||||
|
@DeleteMapping("/{id}")
|
||||||
|
@RequirePermission("team:delete")
|
||||||
|
@Operation(summary = "删除团队")
|
||||||
|
public Result<Void> remove(@PathVariable Long id) {
|
||||||
|
teamService.removeTeam(id);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,89 @@
|
|||||||
|
package com.competition.modules.biz.contest.controller;
|
||||||
|
|
||||||
|
import com.competition.common.result.PageResult;
|
||||||
|
import com.competition.common.result.Result;
|
||||||
|
import com.competition.common.util.SecurityUtil;
|
||||||
|
import com.competition.modules.biz.contest.dto.QueryWorkDto;
|
||||||
|
import com.competition.modules.biz.contest.dto.SubmitWorkDto;
|
||||||
|
import com.competition.modules.biz.contest.service.IContestWorkService;
|
||||||
|
import com.competition.security.annotation.RequirePermission;
|
||||||
|
import io.swagger.v3.oas.annotations.Operation;
|
||||||
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||||
|
import jakarta.validation.Valid;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import org.springframework.web.bind.annotation.*;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
@Tag(name = "作品管理")
|
||||||
|
@RestController
|
||||||
|
@RequestMapping("/contests/works")
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class ContestWorkController {
|
||||||
|
|
||||||
|
private final IContestWorkService workService;
|
||||||
|
|
||||||
|
@PostMapping("/submit")
|
||||||
|
@RequirePermission("work:submit")
|
||||||
|
@Operation(summary = "提交作品")
|
||||||
|
public Result<Map<String, Object>> submit(@Valid @RequestBody SubmitWorkDto dto) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
Long submitterId = SecurityUtil.getCurrentUserId();
|
||||||
|
return Result.success(workService.submitWork(dto, tenantId, submitterId));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/stats")
|
||||||
|
@RequirePermission("work:read")
|
||||||
|
@Operation(summary = "获取作品统计")
|
||||||
|
public Result<Map<String, Object>> getStats(@RequestParam(required = false) Long contestId) {
|
||||||
|
return Result.success(
|
||||||
|
workService.getStats(contestId, SecurityUtil.getCurrentTenantId(), SecurityUtil.isSuperAdmin())
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping
|
||||||
|
@RequirePermission("work:read")
|
||||||
|
@Operation(summary = "查询作品列表")
|
||||||
|
public Result<PageResult<Map<String, Object>>> findAll(QueryWorkDto dto) {
|
||||||
|
Long tenantId = SecurityUtil.getCurrentTenantId();
|
||||||
|
boolean isSuperTenant = SecurityUtil.isSuperAdmin();
|
||||||
|
return Result.success(workService.findAll(dto, tenantId, isSuperTenant));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/guided")
|
||||||
|
@RequirePermission("activity:read")
|
||||||
|
@Operation(summary = "查询辅导作品")
|
||||||
|
public Result<PageResult<Map<String, Object>>> getGuidedWorks(
|
||||||
|
@RequestParam(required = false) Long contestId,
|
||||||
|
@RequestParam(required = false) String workNo,
|
||||||
|
@RequestParam(required = false) String playerName,
|
||||||
|
@RequestParam(required = false) String accountNo,
|
||||||
|
@RequestParam(defaultValue = "1") Long page,
|
||||||
|
@RequestParam(defaultValue = "10") Long pageSize) {
|
||||||
|
Long userId = SecurityUtil.getCurrentUserId();
|
||||||
|
return Result.success(workService.getGuidedWorks(contestId, workNo, playerName, accountNo, page, pageSize, userId));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/{id}")
|
||||||
|
@RequirePermission("work:read")
|
||||||
|
@Operation(summary = "查询作品详情")
|
||||||
|
public Result<Map<String, Object>> findDetail(@PathVariable Long id) {
|
||||||
|
return Result.success(workService.findDetail(id));
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/registration/{registrationId}/versions")
|
||||||
|
@RequirePermission("work:read")
|
||||||
|
@Operation(summary = "查询作品版本历史")
|
||||||
|
public Result<List<Map<String, Object>>> getWorkVersions(@PathVariable Long registrationId) {
|
||||||
|
return Result.success(workService.getWorkVersions(registrationId));
|
||||||
|
}
|
||||||
|
|
||||||
|
@DeleteMapping("/{id}")
|
||||||
|
@RequirePermission("work:update")
|
||||||
|
@Operation(summary = "删除作品")
|
||||||
|
public Result<Void> remove(@PathVariable Long id) {
|
||||||
|
workService.removeWork(id);
|
||||||
|
return Result.success();
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,130 @@
|
|||||||
|
package com.competition.modules.biz.contest.dto;
|
||||||
|
|
||||||
|
import io.swagger.v3.oas.annotations.media.Schema;
|
||||||
|
import jakarta.validation.constraints.NotBlank;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Schema(description = "创建活动DTO")
|
||||||
|
public class CreateContestDto {
|
||||||
|
|
||||||
|
@NotBlank(message = "活动名称不能为空")
|
||||||
|
@Schema(description = "活动名称")
|
||||||
|
private String contestName;
|
||||||
|
|
||||||
|
@NotBlank(message = "活动类型不能为空")
|
||||||
|
@Schema(description = "活动类型")
|
||||||
|
private String contestType;
|
||||||
|
|
||||||
|
@Schema(description = "可见性")
|
||||||
|
private String visibility;
|
||||||
|
|
||||||
|
@Schema(description = "目标城市列表")
|
||||||
|
private List<String> targetCities;
|
||||||
|
|
||||||
|
@Schema(description = "最小年龄")
|
||||||
|
private Integer ageMin;
|
||||||
|
|
||||||
|
@Schema(description = "最大年龄")
|
||||||
|
private Integer ageMax;
|
||||||
|
|
||||||
|
@NotBlank(message = "开始时间不能为空")
|
||||||
|
@Schema(description = "开始时间")
|
||||||
|
private String startTime;
|
||||||
|
|
||||||
|
@NotBlank(message = "结束时间不能为空")
|
||||||
|
@Schema(description = "结束时间")
|
||||||
|
private String endTime;
|
||||||
|
|
||||||
|
@Schema(description = "地址")
|
||||||
|
private String address;
|
||||||
|
|
||||||
|
@Schema(description = "活动内容")
|
||||||
|
private String content;
|
||||||
|
|
||||||
|
@Schema(description = "活动关联租户ID列表")
|
||||||
|
private List<Integer> contestTenants;
|
||||||
|
|
||||||
|
@Schema(description = "封面图URL")
|
||||||
|
private String coverUrl;
|
||||||
|
|
||||||
|
@Schema(description = "海报URL")
|
||||||
|
private String posterUrl;
|
||||||
|
|
||||||
|
@Schema(description = "联系人姓名")
|
||||||
|
private String contactName;
|
||||||
|
|
||||||
|
@Schema(description = "联系人电话")
|
||||||
|
private String contactPhone;
|
||||||
|
|
||||||
|
@Schema(description = "联系人二维码")
|
||||||
|
private String contactQrcode;
|
||||||
|
|
||||||
|
@Schema(description = "主办方")
|
||||||
|
private Object organizers;
|
||||||
|
|
||||||
|
@Schema(description = "协办方")
|
||||||
|
private Object coOrganizers;
|
||||||
|
|
||||||
|
@Schema(description = "赞助方")
|
||||||
|
private Object sponsors;
|
||||||
|
|
||||||
|
@NotBlank(message = "报名开始时间不能为空")
|
||||||
|
@Schema(description = "报名开始时间")
|
||||||
|
private String registerStartTime;
|
||||||
|
|
||||||
|
@NotBlank(message = "报名结束时间不能为空")
|
||||||
|
@Schema(description = "报名结束时间")
|
||||||
|
private String registerEndTime;
|
||||||
|
|
||||||
|
@Schema(description = "报名状态")
|
||||||
|
private String registerState;
|
||||||
|
|
||||||
|
@Schema(description = "是否需要审核")
|
||||||
|
private Boolean requireAudit;
|
||||||
|
|
||||||
|
@Schema(description = "允许的年级列表")
|
||||||
|
private List<Integer> allowedGrades;
|
||||||
|
|
||||||
|
@Schema(description = "允许的班级列表")
|
||||||
|
private List<Integer> allowedClasses;
|
||||||
|
|
||||||
|
@Schema(description = "团队最小人数")
|
||||||
|
private Integer teamMinMembers;
|
||||||
|
|
||||||
|
@Schema(description = "团队最大人数")
|
||||||
|
private Integer teamMaxMembers;
|
||||||
|
|
||||||
|
@Schema(description = "提交规则")
|
||||||
|
private String submitRule;
|
||||||
|
|
||||||
|
@NotBlank(message = "提交开始时间不能为空")
|
||||||
|
@Schema(description = "提交开始时间")
|
||||||
|
private String submitStartTime;
|
||||||
|
|
||||||
|
@NotBlank(message = "提交结束时间不能为空")
|
||||||
|
@Schema(description = "提交结束时间")
|
||||||
|
private String submitEndTime;
|
||||||
|
|
||||||
|
@Schema(description = "作品类型")
|
||||||
|
private String workType;
|
||||||
|
|
||||||
|
@Schema(description = "作品要求")
|
||||||
|
private String workRequirement;
|
||||||
|
|
||||||
|
@Schema(description = "评审规则ID")
|
||||||
|
private Long reviewRuleId;
|
||||||
|
|
||||||
|
@NotBlank(message = "评审开始时间不能为空")
|
||||||
|
@Schema(description = "评审开始时间")
|
||||||
|
private String reviewStartTime;
|
||||||
|
|
||||||
|
@NotBlank(message = "评审结束时间不能为空")
|
||||||
|
@Schema(description = "评审结束时间")
|
||||||
|
private String reviewEndTime;
|
||||||
|
|
||||||
|
@Schema(description = "结果发布时间")
|
||||||
|
private String resultPublishTime;
|
||||||
|
}
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
package com.competition.modules.biz.contest.dto;
|
||||||
|
|
||||||
|
import io.swagger.v3.oas.annotations.media.Schema;
|
||||||
|
import jakarta.validation.constraints.NotBlank;
|
||||||
|
import jakarta.validation.constraints.NotNull;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Schema(description = "创建公告DTO")
|
||||||
|
public class CreateNoticeDto {
|
||||||
|
|
||||||
|
@NotNull(message = "活动ID不能为空")
|
||||||
|
@Schema(description = "活动ID")
|
||||||
|
private Long contestId;
|
||||||
|
|
||||||
|
@NotBlank(message = "公告标题不能为空")
|
||||||
|
@Schema(description = "公告标题")
|
||||||
|
private String title;
|
||||||
|
|
||||||
|
@NotBlank(message = "公告内容不能为空")
|
||||||
|
@Schema(description = "公告内容")
|
||||||
|
private String content;
|
||||||
|
|
||||||
|
@Schema(description = "公告类型")
|
||||||
|
private String noticeType;
|
||||||
|
|
||||||
|
@Schema(description = "优先级")
|
||||||
|
private Integer priority;
|
||||||
|
|
||||||
|
@Schema(description = "发布时间")
|
||||||
|
private String publishTime;
|
||||||
|
}
|
||||||
@ -0,0 +1,26 @@
|
|||||||
|
package com.competition.modules.biz.contest.dto;
|
||||||
|
|
||||||
|
import io.swagger.v3.oas.annotations.media.Schema;
|
||||||
|
import jakarta.validation.constraints.NotBlank;
|
||||||
|
import jakarta.validation.constraints.NotNull;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Schema(description = "创建报名DTO")
|
||||||
|
public class CreateRegistrationDto {
|
||||||
|
|
||||||
|
@NotNull(message = "活动ID不能为空")
|
||||||
|
@Schema(description = "活动ID")
|
||||||
|
private Long contestId;
|
||||||
|
|
||||||
|
@NotBlank(message = "报名类型不能为空")
|
||||||
|
@Schema(description = "报名类型")
|
||||||
|
private String registrationType;
|
||||||
|
|
||||||
|
@Schema(description = "团队ID")
|
||||||
|
private Long teamId;
|
||||||
|
|
||||||
|
@NotNull(message = "用户ID不能为空")
|
||||||
|
@Schema(description = "用户ID")
|
||||||
|
private Long userId;
|
||||||
|
}
|
||||||
@ -0,0 +1,34 @@
|
|||||||
|
package com.competition.modules.biz.contest.dto;
|
||||||
|
|
||||||
|
import io.swagger.v3.oas.annotations.media.Schema;
|
||||||
|
import jakarta.validation.constraints.NotBlank;
|
||||||
|
import jakarta.validation.constraints.NotNull;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Schema(description = "创建团队DTO")
|
||||||
|
public class CreateTeamDto {
|
||||||
|
|
||||||
|
@NotNull(message = "活动ID不能为空")
|
||||||
|
@Schema(description = "活动ID")
|
||||||
|
private Long contestId;
|
||||||
|
|
||||||
|
@NotBlank(message = "团队名称不能为空")
|
||||||
|
@Schema(description = "团队名称")
|
||||||
|
private String teamName;
|
||||||
|
|
||||||
|
@NotNull(message = "队长ID不能为空")
|
||||||
|
@Schema(description = "队长ID")
|
||||||
|
private Long leaderId;
|
||||||
|
|
||||||
|
@Schema(description = "成员ID列表")
|
||||||
|
private List<Long> memberIds;
|
||||||
|
|
||||||
|
@Schema(description = "指导老师ID列表")
|
||||||
|
private List<Long> teacherIds;
|
||||||
|
|
||||||
|
@Schema(description = "最大成员数")
|
||||||
|
private Integer maxMembers;
|
||||||
|
}
|
||||||
@ -0,0 +1,39 @@
|
|||||||
|
package com.competition.modules.biz.contest.dto;
|
||||||
|
|
||||||
|
import io.swagger.v3.oas.annotations.media.Schema;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Schema(description = "查询活动DTO")
|
||||||
|
public class QueryContestDto {
|
||||||
|
|
||||||
|
@Schema(description = "页码", defaultValue = "1")
|
||||||
|
private Long page = 1L;
|
||||||
|
|
||||||
|
@Schema(description = "每页条数", defaultValue = "10")
|
||||||
|
private Long pageSize = 10L;
|
||||||
|
|
||||||
|
@Schema(description = "活动名称")
|
||||||
|
private String contestName;
|
||||||
|
|
||||||
|
@Schema(description = "活动状态")
|
||||||
|
private String contestState;
|
||||||
|
|
||||||
|
@Schema(description = "状态")
|
||||||
|
private String status;
|
||||||
|
|
||||||
|
@Schema(description = "活动类型")
|
||||||
|
private String contestType;
|
||||||
|
|
||||||
|
@Schema(description = "可见性")
|
||||||
|
private String visibility;
|
||||||
|
|
||||||
|
@Schema(description = "活动阶段")
|
||||||
|
private String stage;
|
||||||
|
|
||||||
|
@Schema(description = "创建者租户ID")
|
||||||
|
private Long creatorTenantId;
|
||||||
|
|
||||||
|
@Schema(description = "角色")
|
||||||
|
private String role;
|
||||||
|
}
|
||||||
@ -0,0 +1,33 @@
|
|||||||
|
package com.competition.modules.biz.contest.dto;
|
||||||
|
|
||||||
|
import io.swagger.v3.oas.annotations.media.Schema;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Schema(description = "查询报名DTO")
|
||||||
|
public class QueryRegistrationDto {
|
||||||
|
|
||||||
|
@Schema(description = "页码", defaultValue = "1")
|
||||||
|
private Long page = 1L;
|
||||||
|
|
||||||
|
@Schema(description = "每页条数", defaultValue = "10")
|
||||||
|
private Long pageSize = 10L;
|
||||||
|
|
||||||
|
@Schema(description = "活动ID")
|
||||||
|
private Long contestId;
|
||||||
|
|
||||||
|
@Schema(description = "报名状态")
|
||||||
|
private String registrationState;
|
||||||
|
|
||||||
|
@Schema(description = "报名类型")
|
||||||
|
private String registrationType;
|
||||||
|
|
||||||
|
@Schema(description = "用户ID")
|
||||||
|
private Long userId;
|
||||||
|
|
||||||
|
@Schema(description = "参赛者类型")
|
||||||
|
private String participantType;
|
||||||
|
|
||||||
|
@Schema(description = "关键词")
|
||||||
|
private String keyword;
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user