https://github.com/orca-yun/orca-admin
💐 🐬 虎鲸云直播运营端, 私域直播, H5, Web, 运营, 录播
https://github.com/orca-yun/orca-admin
dashbord javascript live scss vue web
Last synced: 8 months ago
JSON representation
💐 🐬 虎鲸云直播运营端, 私域直播, H5, Web, 运营, 录播
- Host: GitHub
- URL: https://github.com/orca-yun/orca-admin
- Owner: orca-yun
- Created: 2024-08-07T02:25:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-27T06:21:36.000Z (over 1 year ago)
- Last Synced: 2024-12-27T07:22:39.911Z (over 1 year ago)
- Topics: dashbord, javascript, live, scss, vue, web
- Language: Vue
- Homepage: https://admin.orcacl.com
- Size: 3.86 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.DEV.md
Awesome Lists containing this project
README
### 项目功能 🔨
- 使用 Vue3.3 + TypeScript 开发，单文件组件**＜script setup＞**
- 采用 Vite4 作为项目开发、打包工具（配置 gzip/brotli 打包、tsx 语法、跨域代理…）
- 使用 Pinia 替代 Vuex，轻量、简单、易用，集成 Pinia 持久化插件
- 使用 TypeScript 对 Axios 整个二次封装（请求拦截、取消、常用请求封装…）
- 基于 Element 表格页面全部为配置项 Columns
- 支持 Element 组件大小切换、多主题布局、暗黑模式、i18n 国际化
- 使用 VueRouter 配置动态路由权限拦截、路由懒加载，支持页面按钮权限控制
- 使用 KeepAlive 对页面进行缓存，支持多级嵌套路由缓存
- 常用自定义指令开发（权限、复制、水印、拖拽、节流、防抖、长按…）
- 使用 Prettier 统一格式化代码，集成 ESLint、Stylelint 代码校验规范
- 使用 husky、lint-staged、commitlint、czg、cz-git 规范提交信息
### 安装使用步骤 📔
- **Install：**
```text
npm install
```
- **Run：**
```text
npm dev
npm serve
```
- **Build：**
```text
# 开发环境
npm build:dev
# 测试环境
npm build:test
# 生产环境
npm build:pro
```
- **Lint：**
```text
# eslint 检测代码
npm lint:eslint
# prettier 格式化代码
npm lint:prettier
# stylelint 格式化样式
npm lint:stylelint
```
- **commit：**
```text
# 提交代码（提交前会自动执行 lint:lint-staged 命令）
npm commit
```
### 文件资源目录 📚
```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 全局配置文件
```