奥集能平台前端

TS功能文档: ts功能划分

简介

奥集能是面向下一代互联网发展趋势，基于动态演化的复杂系统多主体建模方法，以所有权作为第一优先级，运用零信任安全机制，按自组织分形理念提炼和抽象“沟通、办事、仓库、商店、市场和设置”等基础功能，为b端和c端融合的全场景业务的提供新一代分布式应用架构。

本仓库是奥集能的前端 react 实现。

项目目录

├── .husky                              // husky git hooks配置目录
    ├── _                               // husky 脚本生成的目录文件
    ├── commit-msg                      // commit-msg钩子，用于验证 message格式
    ├── pre-commit                      // pre-commit钩子，主要是和eslint配合
├── config                              // 全局配置文件
    ├── vite                            // vite 相关配置 代理相关
    ├── constant.ts                     // 项目配置
    ├── themeConfig.ts                  // 主题配置
├── dist                                // 默认的 build 输出目录
├── mock                                // 前端数据mock
├── public                              // vite项目下的静态目录
└── src                                 // 源码目录
    ├── assets                          // 公共的文件（如image、css、font等）
    ├── bizcomponents                   // 业务组件
    ├── components                      // 项目组件
    ├── enums                           // 自定义 常量（枚举写法）
    ├── hooks                           // 自定义 hooks
    ├── layouts                         // 全局布局
    ├── routes                          // 路由
    ├── services                        // api封装
    ├── store                           // 状态管理器
    ├── utils                           // 工具库
    ├── pages                           // 页面模块目录 UI层
        ├── Home                        // Home页面模块
        ├── ...
    ├── app.tsx                         // 顶层文件
    ├── index.tsx                       // 项目入口文件
    ├── typings                         // 项目type类型定义文件夹
├── .editorconfig                       // IDE格式规范
├── .env                                // 环境变量
├── .eslintignore                       // eslint忽略
├── .eslintrc                           // eslint配置文件
├── .gitignore                          // git忽略
├── .npmrc                              // npm配置文件
├── .prettierignore                     // prettierc忽略
├── .prettierrc                         // prettierc配置文件
├── commitlint.config                   // git提交配置文件
├── index.html                          // 入口文件
├── LICENSE.md                          // LICENSE
├── package.json                        // package
├── postcss.config.js                   // postcss
├── README.md                           // README
├── tsconfig.json                       // typescript配置文件
└── vite.config.ts                      // vite

技术栈及代码规范

本项目开发使用的主要技术栈为 React 全家桶、Type Script、Less，用来完成项目的框架、样式以及逻辑交互。配合使用 EsLint 语法检查规则，Ant Design、Ant Design Pro UI 组件库，React-Query缓存技术，以及其它的一些前端第三方包。

代码规范请前往 project/rules 文件夹下查看编码规则和规范。

项目依赖环境、安装和运行

奥集能是基于 node 14+ 以上的环境运行，通过 yarn 或者 npm install 下载安装项目依赖包，并通过npm run serve 命令本地运行项目。

参与贡献

1. fork 项目
   1. 首先，找到 fork 按钮，点击以后，你的仓库内就会出现一个一模一样的项目。
2. 项目开发
   1. 按照奥集能项目的编码规则，对代码进行开发。
3. 跟上主项目的步伐
   1. 在你开发的过程中，主项目的代码也可能在更新。此时就需要你同步主项目的代码，找到 Pull request 按钮，点击。
   2. 在左侧选择你的仓库的项目，右侧为主项目，此时你能在下面看到两个项目的区别，点击 create pull request 按钮。
   3. 填写 title，点击 create pull request 按钮。
   4. 进入 pull request 页面，拉到最下面，**点击 Merge pull request 按钮并确认，**现在你和主项目的代码就是同步的了。
4. Pull request
   1. 当你觉得你的代码开发完成，可以推送时，在确保你的修改全部推送到了你的仓库的项目中，然后进入你的仓库的项目页面，点击 New pull request 按钮，
   2. 然后点击 create pull request 按钮进行代码提交。
5. 审核
   1. 待项目的开发者审批完成之后，就是贡献成功了。

进度

• 本地 mockdata.json 完成基础页面逻辑
• 完成接口调试,对 mock 进行替换
• 完成最小可用功能,发布
• 升级,补充
• 移除多余组件