ViteReact启动器

react-shadcn-starter — Vite 启动器模板

作者 hayyi2

基于 Vite、React 与 TypeScript 的启动器模板,集成 shadcn/ui、Tailwind CSS 和 react-router-dom,附带 GitHub Pages 部署工作流。

看看你的网站会是什么样

浏览真实页面截图,比较内容排版与手机效果。点击下方缩略图切换,放大查看整页细节。

2 个预览视图
桌面端首页1 / 2
桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

全部页面与视图 2

截图用于了解视觉与布局,交互效果请以实际项目为准。

采集于 2026-10-02查看来源

值得关注的模板亮点

从已有项目资料中,快速了解它的特点。

01

React + Vite + TypeScript 组合,UI 使用 Tailwind CSS 与 shadcn/ui

02

内置 react-router-dom,已提供带导航和响应式布局的单页应用

03

包含可自定义的 /config 配置目录与 /pages 起始页面

04

按 components、context、config、hook、lib、pages 划分源码结构

05

附带 GitHub Action,可构建并部署到 GitHub Pages

06

采用 MIT 许可,允许免费使用、修改、商用和分发

模板详细介绍

这是一个用于搭建前端应用的启动器模板,技术组合为 React + Vite + TypeScript,UI 层使用 Tailwind CSS 与 shadcn/ui,路由使用 react-router-dom。README 说明它已包含一个带导航和响应式布局的单页应用、可自定义的 `/config` 配置、位于 `/pages` 的简单起始页面,以及用于部署 GitHub Pages 的 GitHub Action。

项目结构按职责划分:`src/components` 存放 React 组件,`src/context` 存放 context,`src/config` 存放配置数据,`src/hook` 存放自定义 hooks,`src/lib` 存放工具函数,`src/pages` 存放页面/功能组件;入口相关文件为 `src/App.tsx`、`src/main.tsx`、`src/Router.tsx` 和 `src/index.css`,根目录包含 `index.html`、`tsconfig.json` 与 `vite.config.ts`。

使用方式为通过 `npx degit hayyi2/react-shadcn-starter my-project` 拉取模板,再执行 `npm install` 与 `npm run dev`。部署到 `gh-pages` 需要修改 `vite.config.ts` 中的 `basenameProd`、在仓库设置中创建 `GITHUB_TOKEN` 部署密钥、提交并推送代码、将 GitHub Pages 指向 `gh-pages` 分支,然后运行 `Build & Deploy` 工作流;如需自动部署,则修改 `.github/workflows/build-and-deploy.yml`,注释 `workflow_dispatch` 并取消注释 `push`。

许可方面,仓库采用 MIT 许可,允许免费使用、修改、商用和分发该版本代码,分发副本或实质性部分时需保留版权声明与完整 MIT 许可声明;代码按现状提供。演示图片、字体、图标等第三方素材以及域名、托管、数据库等外部服务需另行核对各自的许可与费用。

ViteReact启动器

适合你的项目吗?

适用场景

  • 快速启动一个使用 shadcn/ui 组件库的 React 单页应用
  • 需要 react-router-dom 路由与响应式导航布局的前端项目
  • 希望把静态站点通过 GitHub Action 部署到 GitHub Pages
  • 作为学习 Vite + React + TypeScript 项目目录组织的参考模板

适合人群

  • 熟悉 React 与 TypeScript、希望直接使用 shadcn/ui 的开发者
  • 需要现成 GitHub Pages 部署流程的个人项目或演示站点
  • 计划在 Tailwind CSS 基础上自行扩展界面样式的项目

上手与定制指南

结合仓库当前版本的说明,按下面的资料检查内容、配置与运行要求。

  1. 1

    使用 npx degit hayyi2/react-shadcn-starter my-project 拉取模板,然后执行 npm install 与 npm run dev

  2. 2

    部署 gh-pages 前需修改 vite.config.ts 中的 basenameProd

  3. 3

    在 GitHub 仓库设置中创建 GITHUB_TOKEN 部署密钥,并将 Pages 指向 gh-pages 分支

  4. 4

    自动部署需编辑 .github/workflows/build-and-deploy.yml,注释 workflow_dispatch 并取消注释 push

  5. 5

    MIT 许可仅覆盖代码本身,演示图片、字体、图标及外部服务需单独核对许可与费用

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本;免费范围为该版本代码,不代表外部服务或第三方素材免费。

使用时需要遵守

  • 允许免费使用、修改、商用和分发该版本代码。
  • 分发代码副本或实质性部分时,保留原作者版权声明和完整 MIT 许可声明。
  • 代码按现状提供;担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

  • 部署到 GitHub Pages 需在 GitHub 仓库设置中创建名为 GITHUB_TOKEN 的部署密钥,属于外部平台账号配置要求。
  • 使用 GitHub Pages 部署前必须手动修改 vite.config.ts 中的 basenameProd 配置,否则路径可能不正确。
  • 启用自动部署需手动编辑 .github/workflows/build-and-deploy.yml,注释 workflow_dispatch 并取消注释 push 触发。
  • 演示图片、字体、图标及其他第三方素材需按各自许可核对,不能仅凭代码的 MIT 许可判断。
  • 域名、托管、数据库、支付或 AI 等外部服务可能另外收费。
查看原文依据

Permission is hereby granted, free of charge

许可证原文

create deploy key `GITHUB_TOKEN` in github `/settings/keys`

README 原文

change `basenameProd` in `/vite.config.ts`

README 原文

Comment on `workflow_dispatch` - Uncomment on `push`

README 原文
https://github.com/hayyi2/react-shadcn-starter/blob/main/LICENSEhttps://github.com/hayyi2/react-shadcn-starter/blob/main/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-02。结果仅覆盖已读取资料,依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台
GitHub
资料与维护参考分
资料较完整 · 86 / 100
技术栈
Vite · React
网站类型
启动器
这个分数如何计算

本站按许可资料(最高30分)、演示链接(12分)、预览图(10分)、Star数(15分)、记录的维护时间(15分)、描述完整度(8分)、功能记录(5分)和分类资料(5分)计算。它不是代码、安全或性能测试,也不是 Google 评分;有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间
2025-03-19
截图检查日期
2026-10-02

已收录演示链接。请用你的内容与屏幕尺寸检查;有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 Vite。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料,不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

已完成服务器许可规则与 AI 来源核对;未经过人工编辑审核。

查看当时使用的来源资料

SHA-256: 0ff46e0b605ed09eae9fc849d3ede102eccf5f6e28fcd9c912a2e2cbc9d3ce4c

2026-10-02T18:14:49.624Z

来源文件 / 仓库
# React Shadcn Starter

React + Vite + TypeScript template for building apps with shadcn/ui.

## Getting Started

```bash
npx degit hayyi2/react-shadcn-starter my-project
cd my-project
npm install
npm run dev
```

## Getting Done

- [x] Single page app with navigation and responsif layout
- [x] Customable configuration `/config`
- [x] Simple starting page/feature `/pages`
- [x] Github action deploy github pages

## Deploy `gh-pages`

- change `basenameProd` in `/vite.config.ts`
- create deploy key `GITHUB_TOKEN` in github `/settings/keys`
- commit and push changes code
- setup gihub pages to branch `gh-pages`
- run action `Build & Deploy`

### Auto Deploy

- change file `.github/workflows/build-and-deploy.yml`
- Comment on `workflow_dispatch`
- Uncomment on `push`

```yaml
# on:
#   workflow_dispatch:
on:
  push:
    branches: ["main"]
```

## Features

- React + Vite + TypeScript
- Tailwind CSS
- [shadcn-ui](https://github.com/shadcn-ui/ui/)
- [react-router-dom](https://www.npmjs.com/package/react-router-dom)

## Project Structure

```md
react-shadcn-starter/
├── public/            # Public assets
├── src/               # Application source code
│   ├── components/    # React components
│   ├── context/       # contexts components
│   ├── config/        # Config data
│   ├── hook/          # Custom hooks
│   ├── lib/           # Utility functions
│   ├── pages/         # pages/features components
│   ├── App.tsx        # Application entry point
│   ├── index.css      # Main css and tailwind configuration
│   ├── main.tsx       # Main rendering file
│   └── Router.tsx     # Routes component
├── index.html         # HTML entry point
├── tsconfig.json      # TypeScript configuration
└── vite.config.ts     # Vite configuration
```

## License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/hayyi2/react-shadcn-starter/blob/main/LICENSE) file for details.
反馈内容错误

看看同类模板

对比同技术栈与用途的模板,找到更适合的视觉与内容结构。