Skip to content

Sleaf/react-template

Repository files navigation

React Template

  • 自用 React 模板, 推荐使用 yarn 进行包管理,如果要使用 npm ,请替换 package.json 中相关字段。
  • 默认不做回退方案

快速开始

yarn               # 安装依赖
yarn cz            # 通过git-cz提交git commit
 # > cz-lint       # 通过git-cz提交git commit之前格式化代码并检查lint
yarn dev           # 开发模式
 # > dev-https     # 开发模式(启用https)
 # > dev-mock      # 开发模式(启用mock服务器)
yarn build         # 打包生产
 # > analyze       # 打包生产(build之后打开包分析)
yarn lint          # 检查各项lint
 # > lint-eslint   # 单独检查eslint规则
 # > lint-css      # 单独检查stylelint规则
yarn format        # 格式化代码
yarn doc-dev       # 打开文档编写界面 
yarn test          # 运行测试用例

包含功能/库

React & 🔥 Reload

Babel

可访问 Awesome Babel 自行安装喜欢的插件

TypeScript

代码风格限制

  • eslint 及其相关系列插件,保证相关规则
  • prettier 辅助统一格式化代码风格
  • git-cz + husky + commitLint 生成并检查符合规范的commit记录

Https自签支持(localhost)

  • 警告:工程内的证书秘钥等仅为调用特殊浏览器API提供测试开发,用于生产是根本不安全的。
  • 需使用 yarn dev-https 以启用该功能。
  • localCA.keypass phrasesleaf1996 ,证书内容均为个人相关字样
  • localhost.csrchallenge passwordsleaf1996 ,证书内容均为个人相关字样

Mock 服务器

使用 yarn dev-mock 启用 mock 服务器,如需同时启用 HTTPS 请使用 yarn dev-mock --https

  • webpack.dev.ts> devServer > before 注入对应函数实现 mock 服务器
  • 实现函数在 mockServer/index.ts 中,请根据样例和 Express 官方文档 编辑使用。

docsify 文档支持

使用 yarn doc-dev 启用 docsify 服务器,即可在 3202 端口查看编写的文档

  • 文档在 ./docs 目录中,
    • ./develop 为开发文档(对内
    • ./help 为帮助文档(对外
  • 支持 markdown 语法。

回退方案

如有需要请自行安装配置 polyfill / shim / sham

以下默认引用的第三方库为es2015语法,请在webpack中添加转换:

  • react-hanger

其他

  • 多预编译器支持: webpack配置默认支持 less/sass/stylus
    • 默认安装less相关依赖,如需使用其他预编译器请安装对应相关依赖。
  • postcss: 支持 grid 布局,相关现代CSS支持
  • webpack-bundle-analyzer: 使用yarn analyze分析生产包结构
  • @welldone-software/why-did-you-render: 将 react 组件渲染情况在控制台输出(在src/index.tsx中按需开启)
  • 推荐使用 ncu (npm-check-updates) 一键升级依赖,可修改根目录 .ncurc.{json,yml,js} 文件来配置升级选项
  • 各类实用工具

待添加的功能

  • docker 支持
  • 国际化方案支持
  • 多主题方案支持
  • create-react-app 支持

About

自用react模板

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published