{"id":20082598,"url":"https://github.com/lexmin0412/react-template","last_synced_at":"2025-05-06T01:30:35.375Z","repository":{"id":110139941,"uuid":"274142857","full_name":"lexmin0412/react-template","owner":"lexmin0412","description":"React 应用模板，用于个人项目的基座，免去每次初始化项目的繁琐过程，使用的框架/库包括 React、TypeScript、TailwindCSS、React Router、Ant Design、AHooks，依赖管理工具为 PNPM，构建工具为 Vite，具备 Jest 单测和 React Testing Library 组件测试能力，支持 Github Actions 部署，Github Pages 访问。","archived":false,"fork":false,"pushed_at":"2024-11-06T16:03:21.000Z","size":1247,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-06T17:18:15.207Z","etag":null,"topics":["antd","pnpm","react","react-router","tailwindcss","template","typescript","vite"],"latest_commit_sha":null,"homepage":"https://lexmin0412.github.io/react-template","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lexmin0412.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-22T13:21:14.000Z","updated_at":"2024-11-06T16:03:25.000Z","dependencies_parsed_at":"2023-11-29T06:26:28.026Z","dependency_job_id":"4c3eb6eb-6582-449f-b688-28a517fd3ce1","html_url":"https://github.com/lexmin0412/react-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexmin0412%2Freact-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexmin0412%2Freact-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexmin0412%2Freact-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexmin0412%2Freact-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lexmin0412","download_url":"https://codeload.github.com/lexmin0412/react-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224478547,"owners_count":17318102,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["antd","pnpm","react","react-router","tailwindcss","template","typescript","vite"],"created_at":"2024-11-13T15:44:13.287Z","updated_at":"2025-05-06T01:30:35.360Z","avatar_url":"https://github.com/lexmin0412.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React 单页应用模板\n\nReact 应用模板，用于个人项目的基座，免去每次初始化项目的繁琐过程，使用的框架/库包括 React、TypeScript、TailwindCSS、Pure React Router、Ant Design、AHooks，依赖管理工具为 PNPM，构建工具为 Rsbuild，具备 Jest 单测和 React Testing Library 组件测试能力，支持 Github Actions 部署，Github Pages 访问。\n\n## 相关仓库\n\n| 仓库名         | 仓库地址                                     | 说明               |\n|----------------|----------------------------------------------|--------------------|\n| vue-template | https://github.com/lexmin0412/vue-template | vue 单页应用模板 |\n\n## 技术栈\n\n- React V19\n- TypeScript V5\n- TailwindCSS V4\n- Pure React Router V0\n- Ant Design V5\n- AHooks V3\n- PNPM V8\n- Rsbuild V1\n- Jest V29\n\n## 搭建步骤\n\n此模板的搭建步骤如下，记录下来用于后续其他项目的开发。\n\n### 1. 初始化空间\n\n通过 Rsbuild 官方脚手架来初始化应用模板。\n\n```bash\nnpx create-rsbuild\n```\n\n依次输入目录名、选择 React、选择 TypeScript，然后 `cd` 进入目录，通过 `code .` 打开目录。\n\n### 2. 配置 npm 源\n\n在根目录创建 `.npmrc` 文件，然后填入以下内容：\n\n```bash\nregistry=https://registry.npmmirror.com/\n```\n\n### 3. 安装依赖\n\n使用 pnpm 安装依赖：\n\n```bash\npnpm install\n```\n\n### 4. 初始化 Git 配置\n\n```\ngit init\ngit remote add origin git@github.com:lexmin0412/react-template.git\ngit add .\ngit commit -m 'feat: init project'\ngit push -u origin master\n```\n\n### 5. TypeScript 配置调整\n\n配置文件调整:\n- 删除 tsconfig.node.json, 并去除 tsconfig.json 中对它的引用。—— 没必要\n- 将 compilerOptions.moduleResolution 选项值改为 `\"Node\"` —— 解析JSX\n- 添加 `allowSyntheticDefaultImports` 选项并设置为 true —— 确保 `import React from 'react'` 不会报错\n\n代码调整:\n- 去除 main.tsx 中对 App 文件引用的后缀：`import App from './App.tsx` =\u003e `import App from './App`\n\n\n做完以上调整的 tsconfig.json 文件完整内容：\n\n```json\n{\n  \"compilerOptions\": {\n    \"target\": \"ES2020\",\n    \"useDefineForClassFields\": true,\n    \"lib\": [\"ES2020\", \"DOM\", \"DOM.Iterable\"],\n    \"module\": \"ESNext\",\n    \"skipLibCheck\": true,\n\n    /* Bundler mode */\n    \"moduleResolution\": \"Node\",\n\t \"allowSyntheticDefaultImports\": true,\n\t \"allowImportingTsExtensions\": true,\n    \"resolveJsonModule\": true,\n    \"isolatedModules\": true,\n    \"noEmit\": true,\n    \"jsx\": \"react-jsx\",\n\n    /* Linting */\n    \"strict\": true,\n    \"noUnusedLocals\": true,\n    \"noUnusedParameters\": true,\n    \"noFallthroughCasesInSwitch\": true\n  },\n  \"include\": [\"src\"],\n}\n```\n\n### 6. 初始化 Github Actions 配置\n\n#### 6.1 修改 baseURL\n\n在 `rsbuild.config.ts` 中添加如下配置：\n\n```ts\nexport default defineConfig({\n  server: {\n    base: '/react-template'\n  }\n})\n```\n\n#### 6.2 添加 Github Actions 配置文件\n\n在根目录新建 .github/workflows 文件夹，并新建 `deploy.yml` 文件，填入如下内容：\n\n```yaml\nname: Deploy Site to Pages\n\non:\n  push:\n    branches: [master]\n\n  workflow_dispatch:\n\npermissions:\n  contents: read\n  pages: write\n  id-token: write\n\nconcurrency:\n  group: pages\n  cancel-in-progress: false\n\njobs:\n  # Build job\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n        with:\n          fetch-depth: 0 # Not needed if lastUpdated is not enabled\n      - uses: pnpm/action-setup@v2 # pnpm is optional but recommended, you can also use npm / yarn\n        with:\n          version: 8\n          cache: pnpm\n      - name: Setup Node\n        uses: actions/setup-node@v3\n        with:\n          node-version: 18\n          cache: pnpm\n      - name: Setup Pages\n        uses: actions/configure-pages@v3\n      - name: Install dependencies\n        run: pnpm install\n      - name: Build with Rsbuild\n        run: |\n          pnpm run build\n      - name: Upload artifact\n        uses: actions/upload-pages-artifact@v2\n        with:\n          path: dist\n\n  # Deployment job\n  deploy:\n    environment:\n      name: github-pages\n      url: ${{ steps.deployment.outputs.page_url }}\n    needs: build\n    runs-on: ubuntu-latest\n    name: Deploy\n    steps:\n      - name: Deploy to GitHub Pages\n        id: deployment\n        uses: actions/deploy-pages@v2\n\n```\n\n其中，`on.push.branches` 表示触发 action 的分支，选择初始化 Git 时使用的分支即可。\n\n#### 6.3 在 Github 上添加配置\n\n##### 获取 token\n\n进入 Github 点击右上角头像，进入 Settings =\u003e Developer Settings =\u003e Personal access tokens =\u003e Tokens(classic) =\u003e Generate new token，保存生成的 token。\n\n##### 设置 token\n\n进入 repo 页面，进入 Settings =\u003e Secrets and variables =\u003e Actions =\u003e New repository secret，命名为 ACCESS_TOKEN（配置文件中的 `secrets.` 后面的 key ），值为刚刚生成的 token。\n\n#### 6.4 推送代码，查看效果\n\n推送代码到 master，查看 repo 的 Actions 面板，等待 CI 流程执行完毕后，进入 Settings =\u003e Pages，稍等片刻（一两分钟）后，上方就会出现类似如下的文案：\n\n```txt\nYour site is live at https://lexmin0412.github.io/react-template/\n```\n\n点击链接即可访问，后续只要推送代码，就会触发 action 重新部署。\n\n### 7. 设置为模板仓库\n\n进入 repo 页面，进入 Settings =\u003e General, 把 `Template repository` 一项勾上即可，再次切换到 repo 的默认页面，就会出现 `Use this template` 按钮，可以基于此创建一个新仓库。\n\n### 8. 添加 tailwindcss 支持\n\n\u003e 此部分完全参照 Rsbuild 官方 TailwindCSS v4 接入文档操作，详见：https://rsbuild.dev/zh/guide/basic/tailwindcss\n\n#### 8.1 安装依赖\n\n```shell\n# 安装依赖\npnpm add tailwindcss @tailwindcss/postcss -D\n```\n\n#### 8.2 配置 PostCSS\n\n在 `postcss.config.js` 中添加如下内容：\n\n```js\nexport default {\n  plugins: {\n    '@tailwindcss/postcss': {},\n  },\n};\n```\n\n#### 8.3 引入基础类\n\n在入口 css 文件的顶部添加如下内容，这是书写 `tailwind` class 的基础。\n\n```css\n@import 'tailwindcss';\n```\n\n#### 8.4 添加 tailwind 类名，查看效果\n\n在 html 标签上添加一个类名，即可看到效果：\n\n```html\n\u003ch1 className=\"bg-blue\"\u003e\n  Hello world!\n\u003c/h1\u003e\n```\n\n现在我们可以用 `tailwindcss` 来控制绝大部分的样式，`index.css` 和 `App.css` 文件中的样式可以全部删除掉了。\n\n### 9. 接入 pure-react-router, 添加路由支持\n\n\u003e [为什么不使用 react-router-dom ?](https://github.com/lexmin0412/pure-react-router?tab=readme-ov-file#%E4%B8%BA%E4%BB%80%E4%B9%88%E8%A6%81%E6%9C%89-pure-react-router)\n\n#### 9.1 安装依赖：\n\n```shell\npnpm add pure-react-router\n```\n\n#### 9.2 创建、配置路由\n\n新建 `src/routers/index` 文件，添加如下内容:\n\n```tsx\nimport {\n  Link\n} from \"pure-react-router\";\nimport App from \"../App\";\n\nexport const routes = [\n  {\n    path: \"/about\",\n    component: () =\u003e (\n      \u003cdiv\u003e\n        \u003cdiv\u003eAbout\u003c/div\u003e\n\t    \u003cdiv\u003e\n          \u003cLink className=\"cursor-pointer\" to='/' \u003e回到首页\u003c/Link\u003e\n        \u003c/div\u003e\n      \u003c/div\u003e\n    ),\n  },\n  // 注意根路由要放最后\n  {\n    path: \"/\",\n    component: () =\u003e \u003cApp /\u003e,\n  },\n]\n```\n\n#### 9.3 替换入口\n\n将入口文件 `main.tsx` 中引用的最外层组件替换为 `\u003cBrowserRouter /\u003e`, `routes` 属性设置为上面声明的 `routes` 数组。\n\n```tsx\nimport React from 'react'\nimport ReactDOM from 'react-dom/client'\nimport { BrowserRouter, Route } from \"pure-react-router\";\nimport { routes } from './routers';\nimport './index.css'\n\nReactDOM.createRoot(document.getElementById('root')!).render(\n  \u003cReact.StrictMode\u003e\n    \u003cBrowserRouter routes={routes} basename=\"/\"\u003e\n      \u003cRoute /\u003e\n    \u003c/BrowserRouter\u003e\n  \u003c/React.StrictMode\u003e,\n)\n```\n\n### 10. 引入 Ant Design\n\n#### 10.1 安装依赖\n\n时间相关的组件要用到 dayjs, 顺便一起安装了。\n\n```shell\npnpm add antd dayjs\n```\n\n#### 10.2 国际化\n\nAnt Design 的默认语言是英文，要切换为中文时需要进行国际化配置。\n\n在入口组件的最外层嵌套 `ConfigProvider`, 添加 locale 配置:\n\n```tsx\nimport React from \"react\";\nimport ReactDOM from \"react-dom/client\";\nimport { RouterProvider } from \"react-router-dom\";\nimport { ConfigProvider } from \"antd\";\nimport zhCN from \"antd/locale/zh_CN\";\nimport router from \"./routers\";\nimport \"./index.css\";\n\nReactDOM.createRoot(document.getElementById(\"root\")!).render(\n  \u003cReact.StrictMode\u003e\n    \u003cConfigProvider locale={zhCN}\u003e\n      \u003cRouterProvider router={router} /\u003e\n    \u003c/ConfigProvider\u003e\n  \u003c/React.StrictMode\u003e\n);\n```\n\n放到路由容器外层的原因是路由容器组件中也可能会用到 Ant Design 组件（例如弹窗）。\n\n#### 10.3 配置主题\n\nAnt Design V5 采用了 DesignToken 设计，配置主题非常简单。\n\n上面在国际化中已经引入了 `ConfigProvider` 组件，这一步中使用它来修改主题色，给入口文件的 ConfigProvider 添加 theme 属性：\n\n```tsx\n// main.tsx\n\u003cConfigProvider\n  theme={{\n    token: {\n      colorPrimary: \"#ff4a4a\",\n    },\n  }}\n\u003e\n```\n\n`token.colorPrimary` 即为整个系统的主题色。如果要修改其他属性，请查看 [官方文档](https://ant.design/docs/react/customize-theme-cn)。\n\n### 11. 添加自动化测试支持\n\n#### 11.1 安装 jest\n\n```shell\npnpm add jest @types/jest @jest/types\n```\n\n#### 11.2 初始化 jest 配置文件\n\n```shell\nnpx jest --init\n```\n\n按照下面的示例依次选择：\n- add running test script —— yes\n- use TypeScript —— yes\n- test environment —— jsdom(browser-like)\n- add coverage reports —— no\n- provider -- babel\n- clear -- yes\n\n完成选择后，将会在根目录初始化 `jest.config.ts` 文件。\n\n#### 11.3 配置 babel\n\n由于在 provider 项选择了 babel，所以需要安装 babel 相关依赖：\n\n```shell\npnpm add babel-jest @babel/core @babel/preset-env @babel/preset-react @babel/preset-typescript -D\n```\n\n然后新增 `babel.config.cjs` 文件：\n\n```js\n// ./babel.config.cjs\nmodule.exports = {\n  presets: [\n    [\"@babel/preset-env\", { targets: { node: \"current\" } }],\n    [\"@babel/preset-react\",{ runtime: \"automatic\" }], // 自动导入react\n    \"@babel/preset-typescript\",\n  ],\n};\n```\n\n文件后缀为 `.cjs` 是因为 `package.json` 中的 `type` 为 `\"module\"`\n\n#### 11.4 安装附加依赖\n\n根据以上的配置，还需要安装以下依赖：\n\n```shell\npnpm add ts-node jest-environment-jsdom -D\n```\n\n原因：\n\n- jest 在编译 ts 时使用了 ts-node 进行编译\n- 初始化配置时 test enviroment 选择了 jsdom, 所以 jest-environment-jsdom 需要手动安装\n\n#### 11.5 特殊文件格式支持\n\n`jest.config.ts` 中添加如下内容：\n\n```ts\nexport default {\n  transform: {\n\t\t// 声明额外扩展名识别转换器：jest 不知道如何加载除 js/jsx 之外的其他扩展名\n    \"^.+.(js|ts|tsx)$\": \"\u003crootDir\u003e/node_modules/babel-jest\",\n\t\t// mock 自定义 svg 转换\n\t\t\"^.+.svg$\": \"\u003crootDir\u003e/scripts/svg-transform.js\",\n  },\n};\n```\n\n其中，引用的 `scripts/svg-transform.js` 文件内容如下：\n\n```js\nexport default {\n  process() {\n    return { code: \"module.exports = {};\" };\n  },\n  getCacheKey() {\n    return \"svgTransform\"; // SVG固定返回这个字符串\n  },\n};\n```\n\n#### 11.6 CSS 代理\n\n先安装代理库：\n\n```shell\npnpm add identity-obj-proxy\n```\n\n在 jest.config.ts 中添加如下配置：\n\n```ts\nexport default {\n  moduleNameMapper: {\n\t\t// 告诉 Jest 将此对象模拟为导入的 CSS 模块\n    \"\\.(css|less)$\": \"identity-obj-proxy\"\n  }\n};\n```\n\n### 12. 配置 React Testing Library\n\n#### 12.1 安装相关依赖\n\n```shell\npnpm add @testing-library/jest-dom @testing-library/react @testing-library/user-event -D\n```\n\n#### 12.2 全局导入 `@testing-library/jest-dom`\n\n在 jest.config.ts 中添加如下依赖：\n\n```ts\nexport default {\n  // ... other config\n  setupFilesAfterEnv: [\"\u003crootDir\u003e/scripts/jest-dom-setup.js\"],\n};\n```\n\n新建 `scripts/jest-dom-setup.js` 文件，填入如下内容：\n\n```js\nimport '@testing-library/jest-dom'\n```\n\n#### 第一个测试用例\n\n新建 `src/App.test.tsx`, 填入以下内容：\n\n```tsx\n// 这里文件后缀修改为 tsx，因为需要测试 dom\nimport { render, screen } from \"@testing-library/react\";\nimport \"@testing-library/jest-dom\";\nimport App from \"./App\";\n\ndescribe(\"test\", () =\u003e {\n  test(\"first unit test\", () =\u003e {\n    render(\u003cApp /\u003e);\n    expect(screen.getByText(\"Rsbuild + React\")).toBeInTheDocument();\n  });\n});\n```\n\n### 13. 引入 ahooks\n\n为了能够做到开箱即用，引入 ahooks 提供大量的常用 hooks，如 `useRequest`。\n\n```shell\npnpm add ahooks\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flexmin0412%2Freact-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flexmin0412%2Freact-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flexmin0412%2Freact-template/lists"}