Skip to content

zj12357/vip-components

Repository files navigation

📦 使用

$ pnpm

$ pnpm start

🔨 构建

$ pnpm build(生产)

🖥 配置

查看 craco

⌨️ 环境要求

🧰 技术概览

  • 💎 Hooks: 使用最新的 react hooks API 代替传统的 class API
  • 💡 TypeScript: 应用程序级 JavaScript 的语言
  • 📜 区块: 通过区块模板快速构建页面
  • 🚀 最新技术栈: 使用 typescript + react + recoil + react-router-dom + react-query + antd + @ant-design/pro-components 等前端前沿技术开发
  • ⚙️ 最佳实践: 良好的工程实践助您持续产出高质量代码
  • 🌐 国际化: 内建业界通用的国际化方案
  • 使用: 完整的文档和详细的注释,无阻碍使用

🖊️ 命名规范,书写规范

  • 文件目录:按照业务功能划分
  • 组件:文件名+index.tsx,使用 hooks 方式编写组件
  • scss 文件命名格式:*.scoped.scss
  • API:编写 api 响应和参数的类型,使用 react-query 请求数据
  • 数据管理:绝大多数页面的数据流转都是在当前页完成,在页面挂载的时候请求后端接口获取并消费,一些公共的数据存放在 sotre
  • _ vscode 安装插件:prettier, stylelint, eslint, ts-react-snippets _

📁 文件夹结构

  • /api:接口管理
  • /assets:静态文件,图片,css,字体
  • /common:处理公共业务
  • /components:公共组件
  • /config:系统设置
  • /enums:公共 enums
  • /hooks:公共 hooks
  • /layouts:界面布局
  • /locales:国际化翻译
  • /pages:业务页面
  • /router:路由管理
  • /store:数据管理
  • /types:请求响应和参数的定义
  • /utils:通用方法

🔐git 规范

  • 需求分支:feature/*
  • bug 分支:bug_fix/*
  • merge request:
    • 开发环境 develop---> (feature/-- | bug_fix/--) ---> develop
    • 测试环境 test---> (feature/-- | bug_fix/--) ---> test
    • 生产环境 test ---> production

About

组件库

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published