react-pc-tmp 是基于 Create React App(v5)的模板脚手架,集成了 Ant Design 5、JavaScript、carco、Redux、Sass + CSS Moudles 、Tailwind、CSS、Axios(封装)、ESLint、Prettier、lodashjs 等流行技术栈构建 PC 端模板脚手架,开箱即用。
craco 是什么? craco(一个对 create-react-app 进行自定义配置的社区解决方案) 对 create-react-app 的默认配置进行自定义设置。
不支持 IE 浏览器。
Edge
、Firefox
、Chrome
、Safari
等现代浏览器的最新的 2 个版本确保会被支持。
对于这些浏览器的其他版本中,由于开发资源的限制并没有做过严格的测试。但是我预期 react-pc-tmp 应该在这些浏览器不算太老的版本上能正常的运行(比如 2 年之内的版本)。如果你发现了任何问题欢迎来提 issue。
#通过 npm 安装 pnpm (如果本地已安装pnpm,请忽略)
npm install -g pnpm
#安装项目依赖
pnpm install
#开发环境启动
pnpm start
#打包 test 环境代码
pnpm build:test
#打包生产环境代码
pnpm build or pnpm build:prod
#执行 js 类型检查
pnpm lint:fix
#执行 prettier 批量格式化代码
pnpm lint:prettier
##注:详细请阅读package.json 以及对应的环境配置文件(即.env 文件)!
同时在项目根目录下包含一个 run.bat,该文件会列出所有 package.json 中 script 块里面的所有命令,
通过双击该文件,你可以在命令行中输入相应的序号并按 Enter 键,程序将运行你选择的脚本。
基础组件文件命名应该以 base 为前缀命名,以示其唯一性,并且以横线连接。
例子:
src
└─ resources
└─ components
└─ base-list
├─ index.js //源码
├─ index.scss //样式
└─ README.md //组件使用说明文档
业务组件文件命名应该以 the 为前缀命名,以示其唯一性,并且以横线连接。
例子:
src
└─ views
└─ components
└─ the-loading
├─ index.js //源码
├─ index.scss //样式
└─ README.md //组件使用说明文档
为了方便维护与开发,建议路由文件命名与对应的页面文件命名保持一致,尽量简洁明了。
例子:
src
└─ config
└─ router
|- index.js
|- dev.js
└─ home.js
为了方便维护与开发,建议接口文件命名与对应的页面文件命名保持一致,尽量简洁明了。
例子:
src
└─ config
└─ apis
└─ index.js
为了方便维护与开发,建议以当前对应模块或者功能命名文件夹,尽量简洁明了。
例子:
src
└─ config
└─ store
└─ dev
└─ index.js
建议图片文件夹命名与对应的页面文件命名保持一致,公共图片资源放置到 src/assets/img/base 目录下即可。
例子:
src
└─ assets
└─ img
一般项目分主分支(master)和其他分支。 当有团队成员要开发新功能(Feather)或改 BUG(Fix) 时,就从 master 分支开一个新的分支。
版本号以 v 开头,根据当前仓库的 tag 编号进行累加,如:v1.10.45。
react-pc-tmp
├─ .env.development // 开发环境配置文件
├─ .env.production // 生产环境配置文件
├─ .env.test // 测试环境配置文件
├─ .eslintignore // ESLint 忽略配置
├─ .eslintrc.js // ESlint配置文件
├─ .npmrc // npm 配置文件
├─ .prettierrc.js // Prettier 配置文件
├─ .vscode // VS Code 配置目录
│ └─ settings.json // VS Code 设置文件
├─ babel.config.js // Babel 配置文件
├─ craco.config.js // 构建脚本(webpack配置)
├─ jsconfig.json // JS 配置文件
├─ package.json // 项目依赖和配置信息
├─ pnpm-lock.yaml // pnpm 包锁定文件
├─ postcss.config.js // PostCSS 配置文件
├─ public // 公共资源目录
│ ├─ index.html // HTML 模板文件
│ └─ static // 静态资源目录
│ └─ favicon.ico // 网站图标
├─ README.md // 项目使用说明文档
├─ run.bat // 批处理文件脚本
├─ src // 源代码目录
│ ├─ App.js // 应用入口组件
│ ├─ assets // 静态资源目录,包含样式和图片,进行了 hash 处理
│ ├─ config // 业务配置目录
│ ├─ index.js // 项目入口文件
│ ├─ layout // 基础布局组件目录
│ ├─ packages // 项目配套的第三方包配置目录
│ ├─ reportWebVitals.js // Web性能报告配置文件
│ ├─ resources // 全局基础资源如基础组件、全局插件等配置目录
│ ├─ utils // 工具库目录
│ └─ views // 视图层目录
└─ tailwind.config.js // Tailwind CSS 配置文件
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。