# embed-boss

**Repository Path**: zyj520/embed-boss

## Basic Information

- **Project Name**: embed-boss
- **Description**: webpack5+react18+ts+eslint8项目模板
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-11
- **Last Updated**: 2025-02-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 项目描述

嵌套到boss的react项目

### 技术栈

涉及的技术栈均采用当前最新的版本和语法：

- 基于 antd5 组件二次封装

- 完整项目实现及模块结构拆分；

### 目录结构

```
├── build                   // webpack配置
│   ├── webpack.common.js   // webpack通用配置
│   ├── webpack.dev.js      // webpack开发环境配置
|   ├── webpack.dll.js      // webpack 打包不变更组件库配置
│   └── webpack.prod.js     // webpack生产环境配置
├── embedBoss               // 打包输出目录
├── embedBossDll            // 不变更组件库输出目录
├── src                     // src开发目录
│   ├── api                 // 接口
│   ├── common              // 通用变量
│   ├── components          // 业务组件
│   ├── globalStyles        // 全局样式
│   ├── layouts             // 项目布局
│   ├──  models             // 类定义 
│   ├──  pages              // 页面
│   ├──  redux              // 状态存储
│   ├──  routes             // 路由配置
│   ├──  types              // ts配置
│   ├──  utils              // 工具函数
├── babel.config.js         // babel配置
├── .editorconfig           // vscode项目格式配置
├── .eslintrc.js            // ESLint配置
├── .gitignore              // git 忽略配置
├── postcss.config.js       // postcss配置
├── commitlint.config.js    // git 分支、commit 配置
├── package.json            // 依赖包配置
└── README.md               // 项目说明
└── husky                   // 代码提交配置
```

## CLI 构建命令

### 初始化依赖配置

```bash
yarn add
```

### 开发环境 启动运行

```bash
yarn dev
```

### 生产环境 打包构建

注： npm 下载的第三方包都要注入到 webpack.dll.js--entry 中，以防止每次打包都要构建，如果注入到其中的第三方包版本更新，则需要yarn dll 重新构建,并上传服务端相关目录。

```bash

yarn prod  //生产环境 打包构建

yarn report // 图形化分析打包文件大小；

yarn dll  // 第三方包构建 ，entry注入的包版本更新时要重新构建

```

## 规范

### 分支创建、提交规范

    test1: test1环境，test2:test2环境, pre:预发环境 ,feat/...:新功能,fix/...:bug修改,publish/...发布npm包 feat/fix/style/test/chore/ci...

只能基于 master 分支创建新分支，test 分支只能用作 merge 自己的开发分支
自动检测

### 语法

    遵循项目ESlint
    自动识别

### 代码格式

    遵循项目Prettier
    自动格式化

### 文件、文件夹命名规则

    小驼峰、大驼峰

### 组件命名规则

    大驼峰

### 变量、函数命名规则

    小驼峰

### 样式

    css选择器命名以 _ 分割
    文件命名参考对应组件或页面名称

### 组件

    公共组件创建在components文件夹下
    私有组件以文件夹形式创建在对应页面文件夹下

### 路由

    详情页路由采用复用形式通过传参区别业务场景，其他创建规则不变

### 服务

    页面不允许单独报错，所有报错逻辑、UI控制在服务层，除自定义场景，

控制台警告提示(react)请及时处理

### 其他

    线上代码不允许有 console
    函数，代码块请所属按功能写注释