官网扫码验证迁移

2025-05-09 17:18:04 +08:00
parent 92d1421d28
commit 74a96a356e
194 changed files with 36970 additions and 124 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,106 @@
-# orico-code
+# orico_code 本项目已全部引入 TS

-官网扫码验证
+### node 版本
+
+16.12.0
+
+### nrm 安装(镜像源管理)
+
+npm i -g nrm
+
+npm use taobao
+
+### 依赖安装
+
+npm i
+
+### 运行
+
+npm run dev (开发)
+
+npm run build:test(测试)
+
+npm run build:pro(生产)
+
+npm run lint:prettier(修复 prettier 报错)
+
+npm run lint:stylelint(修复 样式 报错)
+
+npm run lint:eslint(修复 eslint 报错)
+
+### 环境配置
+
+env.test(测试)
+
+env.development(开发)
+
+env.production(生产)
+
+### 提交(已添加提交规范)
+
+npm run commit
+
+### 分支说明 dev->test->pro
+
+master（模板分支，只有项目模板方便以后通用，禁止将代码合并到 master）
+
+pro (生产分支，用于生产环境，来源于合并 test 分支)
+
+test (测试分支，用于测试环境,来源于合并 dev 分支)
+
+dev(开发分支，用于开环境、解决冲突，来源于其他开发分支)
+
+分支拉取请从 pro 分支进行拉取！
+
+冲突请在 dev 分支解决，解决冲突后再合并测试分支
+
+### 文件资源目录 📚
+
+```text
+├─ .husky                 # husky 配置文件
+├─ .vscode                # VSCode 推荐配置
+├─ build                  # Vite 配置项
+├─ public                 # 静态资源文件（该文件夹不会被打包）
+├─ src
+│  ├─ api                 # API 接口管理
+│  ├─ assets              # 静态资源文件
+│  ├─ components          # 全局组件
+│  ├─ config              # 全局配置项
+│  ├─ directives          # 全局指令文件
+│  ├─ enums               # 项目常用枚举
+│  ├─ hooks               # 常用 Hooks 封装
+│  ├─ languages           # 语言国际化 i18n
+│  ├─ layouts             # 框架布局模块
+│  ├─ routers             # 路由管理
+│  ├─ stores              # pinia store
+│  ├─ styles              # 全局样式文件
+│  ├─ typings             # 全局 ts 声明
+│  ├─ utils               # 常用工具库
+│  ├─ views               # 项目所有页面
+│  ├─ App.vue             # 项目主组件
+│  ├─ main.ts             # 项目入口文件
+│  └─ vite-env.d.ts       # 指定 ts 识别 vue
+├─ .editorconfig          # 统一不同编辑器的编码风格
+├─ .env                   # vite 常用配置
+├─ .env.development       # 开发环境配置
+├─ .env.production        # 生产环境配置
+├─ .env.test              # 测试环境配置
+├─ .eslintignore          # 忽略 Eslint 校验
+├─ .eslintrc.cjs          # Eslint 校验配置文件
+├─ .gitignore             # 忽略 git 提交
+├─ .prettierignore        # 忽略 Prettier 格式化
+├─ .prettierrc.cjs        # Prettier 格式化配置
+├─ .stylelintignore       # 忽略 stylelint 格式化
+├─ .stylelintrc.cjs       # stylelint 样式格式化配置
+├─ CHANGELOG.md           # 项目更新日志
+├─ commitlint.config.cjs  # git 提交规范配置
+├─ index.html             # 入口 html
+├─ LICENSE                # 开源协议文件
+├─ lint-staged.config.cjs # lint-staged 配置文件
+├─ package-lock.json      # 依赖包包版本锁
+├─ package.json           # 依赖包管理
+├─ postcss.config.cjs     # postcss 配置
+├─ README.md              # README 介绍
+├─ tsconfig.json          # typescript 全局配置
+└─ vite.config.ts         # vite 全局配置文件
+```