目录结构

目录树

├─package-lock.json
├─package.json ------------ // 项目配置
├─postcss.config.js ------- // postcss 配置
├─public ------------------ // 公开目录
│ ├─favicon.ico
│ └─index.html
├─README.md ---------- // 项目说明
└─src --------------------- // 源码目录
├─App.tsx --------------- // 根组件
├─assets ---------------- // 静态资源目录
│ └─images -------------- // 图片目录
│  └─logo.png ------ // logo 图片
│ └─svg -------------- // 图标目录
│  └─logo.svg ------ // logo 图片
├─components ------------ // 公共组件目录
│ └─Menu ---------------- // 公共组件
│ ├─index.tsx ---------- // 组件文件
│ └─index.scss ------ // 组件样式
├─constants ---------------- // 项目常量
│ └─index.ts
├─libs ------------------ // 第三方库目录
├─index.tsx --------------- // 主入口
├─router ---------------- // 路由配置
│ └─index.tsx
├─store ----------------- // 状态管理
│ ├─module.ts // 模块
│ └─index.ts // 入口
├─tests ----------------- // 测试目录
├─utils ----------------- // 工具目录
│ ├─a.ts
│ └─index.ts
└─pages ----------------- // 视图目录
└─Home ---------------- // 页面组件
├─components -------- // 子组件目录
│ └─Header
│ ├─index.tsx
│ └─index.scss
└─index.tsx ---------- // 组件主体

README.md 项目说明

说明: 提供关于项目的关键信息或者相关信息的入口. 一般包含下列信息:

  • 简要描述、项目主要特性
  • 运行环境/依赖、安装和构建、测试指南
  • 简单示例代码
  • 文档或文档入口, 其他版本或相关资源入口
  • 联系方式、讨论群
  • 开发指南