feat: README
This commit is contained in:
wf
parent
f6d39c5ba4
commit
4256c98a33
5
.env.test
Normal file
5
.env.test
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
# 开发环境
|
||||||
|
VITE_USER_NODE_ENV = development
|
||||||
|
|
||||||
|
# 开发环境地址前缀 (一般 '/' 或 './' 都可以)
|
||||||
|
VITE_PUBLIC_PATH = '/'
|
||||||
165
README.md
165
README.md
@ -1,9 +1,156 @@
|
|||||||
# Vue 3 + TypeScript + Vite
|
# DC-Admin
|
||||||
|
|
||||||
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
|
### 介绍 📖
|
||||||
|
|
||||||
## Recommended Setup
|
DC-Admin 一款基于 Vue3、TypeScript、Vite5、Pinia、Arco-Design 开源的后台管理框架，使用目前最新技术栈开发。项目提供了一些常用组件，在一定程度上提高您的开发效率。另外本项目还封装了一些常用组件、Hooks、动态路由等功能。
|
||||||
|
|
||||||
- [VS Code](https://code.visualstudio.com/) + [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (previously Volar) and disable Vetur
|
|
||||||
|
### 在线预览 👀
|
||||||
- Use [vue-tsc](https://github.com/vuejs/language-tools/tree/master/packages/tsc) for performing the same type checking from the command line, or for generating d.ts files for SFCs.
|
|
||||||
|
- 链接：建设中
|
||||||
|
|
||||||
|
### 代码仓库 ⭐
|
||||||
|
|
||||||
|
- Gitee：https://gitee.com/wang_fan_w/dc-admin
|
||||||
|
|
||||||
|
### 项目文档 📚
|
||||||
|
|
||||||
|
- 项目更新日志：建设中
|
||||||
|
|
||||||
|
- 项目文档地址：建设中
|
||||||
|
|
||||||
|
### 项目功能 🔨
|
||||||
|
|
||||||
|
- 使用 Vue3 + TypeScript 开发，单文件组件**＜script setup＞**
|
||||||
|
- 采用 Vite5 作为项目开发
|
||||||
|
- 使用 Pinia 替代 Vuex，轻量、简单、易用，集成 Pinia 持久化插件
|
||||||
|
- 使用 TypeScript 对 Axios 整个二次封装（请求拦截、取消、常用请求封装…）
|
||||||
|
- 支持 Arco-Design 组件大小切换、多主题布局、暗黑模式、i18n 国际化
|
||||||
|
- 使用 VueRouter 配置动态路由权限拦截、路由懒加载，支持页面按钮权限控制
|
||||||
|
- 使用 KeepAlive 对页面进行缓存，支持多级嵌套路由缓存
|
||||||
|
- 使用 Prettier 统一格式化代码，集成 ESLint、Stylelint 代码校验规范
|
||||||
|
- 使用 husky、lint-staged、commitlint等插件，规范提交信息
|
||||||
|
|
||||||
|
### 安装使用步骤 📔
|
||||||
|
|
||||||
|
- **Clone：**
|
||||||
|
|
||||||
|
```text
|
||||||
|
# Gitee
|
||||||
|
git clone https://gitee.com/wang_fan_w/dc-admin.git
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Install：**
|
||||||
|
|
||||||
|
```text
|
||||||
|
pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Run：**
|
||||||
|
|
||||||
|
```text
|
||||||
|
pnpm dev
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Build：**
|
||||||
|
|
||||||
|
```text
|
||||||
|
# 开发环境
|
||||||
|
pnpm run dev
|
||||||
|
|
||||||
|
# 测试环境
|
||||||
|
pnpm run preview
|
||||||
|
|
||||||
|
# 生产环境
|
||||||
|
pnpm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Lint：**
|
||||||
|
|
||||||
|
```text
|
||||||
|
# eslint 检测代码
|
||||||
|
pnpm lint:eslint
|
||||||
|
|
||||||
|
# prettier 格式化代码
|
||||||
|
pnpm lint:prettier
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### 项目截图 📷
|
||||||
|
|
||||||
|
- 登录页：
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- 首页：
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- 表格页：
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- 用户中心：
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- 系统配置页：
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 文件资源目录 📚
|
||||||
|
|
||||||
|
```text
|
||||||
|
DC-Admin
|
||||||
|
├─ .husky # husky 配置文件
|
||||||
|
├─ .vscode # VSCode 推荐配置
|
||||||
|
├─ build # Vite 配置项
|
||||||
|
├─ public # 静态资源文件（该文件夹不会被打包）
|
||||||
|
├─ src
|
||||||
|
│ ├─ api # API 接口管理
|
||||||
|
│ ├─ assets # 静态资源文件
|
||||||
|
│ ├─ components # 全局组件
|
||||||
|
│ ├─ config # 全局配置项
|
||||||
|
│ ├─ directives # 全局指令文件
|
||||||
|
│ ├─ hooks # 常用 Hooks 封装
|
||||||
|
│ ├─ lang # 语言国际化 i18n
|
||||||
|
│ ├─ layout # 框架布局模块
|
||||||
|
│ ├─ router # 路由管理
|
||||||
|
│ ├─ store # pinia store
|
||||||
|
│ ├─ style # 全局样式文件
|
||||||
|
│ ├─ typings # 全局 ts 声明
|
||||||
|
│ ├─ utils # 常用工具库
|
||||||
|
│ ├─ views # 项目所有页面
|
||||||
|
│ ├─ App.vue # 项目主组件
|
||||||
|
│ ├─ main.ts # 项目入口文件
|
||||||
|
│ └─ vite-env.d.ts # 指定 ts 识别 vue
|
||||||
|
├─ .env # vite 常用配置
|
||||||
|
├─ .env.development # 开发环境配置
|
||||||
|
├─ .env.production # 生产环境配置
|
||||||
|
├─ .env.test # 测试环境配置
|
||||||
|
├─ .eslintignore # 忽略 Eslint 校验
|
||||||
|
├─ .eslintrc.cjs # Eslint 校验配置文件
|
||||||
|
├─ .gitignore # 忽略 git 提交
|
||||||
|
├─ .prettierignore # 忽略 Prettier 格式化
|
||||||
|
├─ .prettierrc.cjs # Prettier 格式化配置
|
||||||
|
├─ commitlint.config.cjs # git 提交规范配置
|
||||||
|
├─ index.html # 入口 html
|
||||||
|
├─ package-lock.json # 依赖包包版本锁
|
||||||
|
├─ package.json # 依赖包管理
|
||||||
|
├─ README.md # README 介绍
|
||||||
|
├─ tsconfig.json # typescript 全局配置
|
||||||
|
└─ vite.config.ts # vite 全局配置文件
|
||||||
|
```
|
||||||
|
|
||||||
|
### 浏览器支持 🌎
|
||||||
|
|
||||||
|
- 本地开发推荐使用 Chrome 最新版浏览器 [Download](https://www.google.com/intl/zh-CN/chrome/)。
|
||||||
|
- 生产环境支持现代浏览器，不再支持 IE 浏览器，更多浏览器可以查看 [Can I Use Es Module](https://caniuse.com/?search=ESModule)。
|
||||||
|
|
||||||
|
|  |  |  |  |  |
|
||||||
|
| :---------------------------------------------: | :-----------------------------------------------: | :--------------------------------------------------: | :-------------------------------------------------: | :-------------------------------------------------: |
|
||||||
|
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
||||||
|
|
||||||
|
### 项目后台接口 🧩
|
||||||
|
|
||||||
|
建设中
|
||||||
Loading…
x
Reference in New Issue
Block a user