https://github.com/un-pany/v3-electron
⭐ A vue3 electron template, based on 'vue-cli'
https://github.com/un-pany/v3-electron
electron element-plus template typescript vue-cli vue3
Last synced: about 1 year ago
JSON representation
⭐ A vue3 electron template, based on 'vue-cli'
- Host: GitHub
- URL: https://github.com/un-pany/v3-electron
- Owner: un-pany
- License: mit
- Created: 2022-01-07T02:05:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-30T00:57:27.000Z (almost 3 years ago)
- Last Synced: 2025-04-20T01:33:01.028Z (about 1 year ago)
- Topics: electron, element-plus, template, typescript, vue-cli, vue3
- Language: Vue
- Homepage:
- Size: 2.64 MB
- Stars: 12
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> 国内环境在安装依赖和打包时，需要开启 .npmrc 文件中的镜像源配置
## ⚡️ 简介
完全基于 [v3-admin](https://github.com/un-pany/v3-admin) 的 Electron 项目模板，文档也请参考 v3-admin 的文档。
## ⌛ 功能
```text
- 用户管理
- 登录
- 注销
- 权限验证
- 页面权限
- 指令权限
- 多环境
- development
- test
- production
- 全局功能
- svg
- 多主题切换（内置黑暗主题）
- 动态侧边栏
- 动态面包屑
- 标签页快捷导航
- Screenfull 全屏
- 自适应收缩侧边栏
- 错误页面
- 401
- 404
- Dashboard
- admin
- editor
```
## 目录结构
```
# v3-electron
├─ .env.development # 开发环境
├─ .env.production # 生产环境
├─ .env.test # 测试环境
├─ .eslintrc.js # eslint
├─ .npmrc # 国内镜像
├─ public
│ ├─ favicon.ico
│ ├─ index.html
├─ src
│ ├─ @types # ts 声明
│ ├─ api # api 接口
│ ├─ assets # 静态资源
│ ├─ components # 全局组件
│ ├─ config # 全局配置
│ ├─ constant # 常量/枚举
│ ├─ directives # 全局指令
│ ├─ icons # svg icon
│ ├─ layout # 布局
│ ├─ locales # 国际化
│ ├─ model # 全局 model
│ ├─ plugins # 插件
│ ├─ router # 路由
│ ├─ store # vuex store
│ ├─ styles # 全局样式
│ ├─ utils # 全局公共方法
│ └─ views # 所有页面
│ ├─ App.vue # 入口页面
│ ├─ background.ts # 主进程
│ ├─ main.ts # 入口文件
│ └─ shims.d.ts # 模块注入
├─ tsconfig.json # ts 编译配置
└─ vue.config.js # vue-cli 配置
```
## 🚀 开发
```bash
# 配置
node 版本 16.x
# 安装依赖
yarn
# 启动服务
yarn dev
```
## 📦️ 打包
```bash
# 构建测试环境
yarn build:test
# 构建生产环境
yarn build:prod
```
## 🔧 代码格式检查
```bash
yarn lint
```
## Git 提交规范
- `feat` 增加新功能
- `fix` 修复问题/BUG
- `style` 代码风格相关无影响运行结果的
- `perf` 优化/性能提升
- `refactor` 重构
- `revert` 撤销修改
- `test` 测试相关
- `docs` 文档/注释
- `chore` 依赖更新/脚手架配置修改等
- `workflow` 工作流改进
- `ci` 持续集成
- `types` 类型定义文件更改
- `wip` 开发中
- `mod` 不确定分类的修改
## 📄 License
[MIT](https://github.com/un-pany/v3-electron/blob/main/LICENSE)
Copyright (c) 2022 UNPany