对于刚刚工作的同学来说,可能对项目文件规范、代码规范没有什么概念,以至于写出来的代码、创建的文件比较凌乱,避免不了受到上级的批评。
本篇文章主要是带领同学们熟悉项目文件目录,让同学们知道每个文件中应该放什么代码,一个萝卜一个坑,这样子才能让我们的项目文件更加美观、容易阅读、方便使用。
值得注意的是,一些中、小型项目,会把每个页面的ts类型、枚举、api、方法这些类型的文件统一放在指定的文件夹中,看起来会更加美观,但是不利于多人协同(特别是提交代码时经常造成冲突),所以本篇文章中,每个页面中的ts类型、枚举、api、方法都存放在自己的utils文件夹中(公共的存放在src下的utils中),页面更加独立,更加适用于协同开发(总之两者都有自己的特色)。
- node_modules — 用于存放第三方依赖包(一般我们不需要动)
- public — 存放网站的静态资源文件
- favicon.icon — 网站在浏览器页签中所展示的icon图标
- index.html — 项目的入口文件
- manifest.json — 该文件是一个套壳的配置文件,当我们的项目需要在手机端运行时,就需要在这个文件里面进行配置。
- robots.txt — 爬虫协议文件
- config — 配置文件(bigfish规范)
- config.ts — config配置(dev、test、线上环境的机器(地址)正是在这个文件中配置的)
- route.ts — 存放路由配置
- src — 存放源代码
- layout — 项目布局文件,常见于后台项目
- reduxs — 存放全局状态管理文件
- action — 存放修改应用状态的事件
- store — 保存应用的状态并提供一些帮助方法来存取状态,分发状态以及注册监听。
- reducer — 获得这个应用的当前状态和事件然后返回一个新状态的函数。
- typings — 存放全局类型ts约束文件
- utils — 存放工具类的文件夹
- apis — 存放公共api
- fetch — 配置接口文件
- enums — 存放公共枚举
- hooks — 存放公共hooks
- common.ts — 存放公共方法
- random.tsx — 存放其他方法
- components — 存放公共组件的文件夹
- pages — 存放页面组件的文件夹
- HomePage — 页面组件(不同公司可能有不同的命名规范)
- components. — 页面组件抽离的模块(按需创建)
- ChirdModel — 某个公共组件
- index.tsx — 公共组件源码(必须)
- index.less — 公共组件样式(按需创建)
- ChirdModel — 某个公共组件
- utils — 页面中的工具类文件(按需创建)
- apis — 页面中的api
- enums — 页面中枚举
- types — 页面中的ts类型约束
- index.tsx. — 页面组件源码(必须)
- index.less — 页面组件样式(按需创建)
- components. — 页面组件抽离的模块(按需创建)
- userManagementPages — 页面组件文件夹(用户管理模块)
- userManagementListPage — 用户列表页(内部结构同上述的HomePage)
- userManagementCreatePage — 新增用户页
- userManagementEditPage — 编辑用户页
- userManagementImportPage — 导入用户页
- HomePage — 页面组件(不同公司可能有不同的命名规范)
- App.css — App组件的样式
- App.js — App组件 (重要)
- index.css — 样式
- index.js — 入口文件 (重要)
- .gitignore — git的选择性上传的配置文件
- package.json — Webpack配置和项目包管理文件
- README.md — 项目说明文件