xin2017338/snapPrompt

★ 0Forks 0TypeScriptGitHub ↗Compare

README

snapPrompt

基于 Vite + pnpm + React + TypeScript + TailwindCSS + shadcn/ui 的多页项目模板,默认适配 GitHub Pages。

技术栈

  • Vite
  • pnpm
  • React 19 + TypeScript
  • TailwindCSS
  • shadcn/ui(配置与示例基础组件)
  • React Router(Hash 路由)

本地开发

pnpm install
pnpm dev

默认开发模式为 full,可同时访问 #/pc 与 #/m。

如需本地模拟线上 H5-only 行为:

pnpm run dev:h5

构建与预览

pnpm build
pnpm preview

默认生产构建为 H5-only,仅输出 /m 路由。

如需本地额外构建完整 PC + H5 包:

pnpm run build:full
pnpm run preview:full

显式执行 H5-only 构建:

pnpm run build:h5
pnpm run preview:h5

目录说明

src/
  app/
    router.tsx                # Hash 路由配置
  components/
    ui/
      button.tsx              # shadcn 风格基础组件
  features/
    shared/                   # 端无关公共模块
    h5/                       # 移动端页面片段
    pc/                       # 桌面端页面片段
  hooks/
    useIsMobile.ts            # 设备判定 Hook
  lib/
    utils.ts                  # 工具函数
  pages/
    HomePage.tsx
    FeaturesPage.tsx
    AboutPage.tsx

H5/PC 分割策略

  • 路由按构建目标装配:
  • 开发环境: 自动提供 /pc 与 /m,根路径跳转 /pc
  • 生产构建默认: 仅提供 /m,根路径跳转 /m
  • 如需显式保留 PC 构建,使用 VITE_BUILD_TARGET=full 或 pnpm run build:full
  • 页面层只做组装,具体实现分别放到 features/h5 与 features/pc
  • 公共结构放在 features/shared

GitHub Pages 部署

  • Vite base 已配置为 /snapPrompt/
  • 已提供 GitHub Actions 工作流:.github/workflows/deploy.yml
  • 工作流构建命令使用默认 pnpm build,而默认生产构建即为 H5-only
  • 在仓库设置中启用 Pages,Source 选择 GitHub Actions

部署触发条件:推送到 main 分支。

Contributors

xin2017338

Issues