gfwleak/handingkang-ohmyweb
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

修改README

Browse Source
This commit is contained in:
韩丁康
2024-01-08 08:25:16 +00:00
parent 9510639b49
commit 364a34ebfd
3 changed files with 189 additions and 287 deletions
Download Patch File Download Diff File Expand all files Collapse all files

163
README.en.md Normal file
View File

@@ -0,0 +1,163 @@
<div align="center">
<img alt="V3 Admin Vite Logo" width="120" height="120" src="./src/assets/layouts/logo.png">
<h1>V3 Admin Vite</h1>
<span>English | <a href="./README.zh-CN.md">中文</a></span>
</div>
## ⚡ Introduction
V3 Admin Vite is a free and open source middle and background management system basic solution, based on mainstream framework such as Vue3, TypeScript, Element Plus, Pinia and Vite
- Vue Cli 5.x: [v3-admin](https://github.com/un-pany/v3-admin)
- Electron desktop: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
China repository: [Gitee](https://gitee.com/un-pany/v3-admin-vite)
## 📚 Document
- Chinese documentation: [link](https://juejin.cn/post/7089377403717287972)
- Chinese getting started tutorial: [link](https://juejin.cn/column/7207659644487139387)
## 📺 Online preview
| Location | account | Link |
| ------------ | ------------------- | ----------------------------------------------- |
| github-pages | `admin` or `editor` | [link](https://un-pany.github.io/v3-admin-vite) |
## ❤️ Generate electricity with love
- **Completely free**：But hopefully you order a star !!!
- **Very concise**：No complicated encapsulation, no complicated type gymnastics, out of the box
- **Detailed annotations**：Each configuration item is written with as detailed comments as possible
- **Latest dependencies**: Regularly update all third-party dependencies to the latest version
- **Very specification**: The code style is unified, the naming style is unified, and the comment style is unified
## Feature
- **Vue3**：The latest Vue3 composition API using Vue3 + script setup
- **Element Plus**：Vue3 version of Element UI
- **Pinia**: An alternative to Vuex in Vue3
- **Vite**：Really fast
- **Vue Router**：router
- **TypeScript**：JavaScript With Syntax For Types
- **PNPM**：Faster, disk space saving package management tool
- **Scss**：Consistent with Element Plus
- **CSS variable**：Mainly controls the layout and color of the item
- **ESlint**：Code verification
- **Prettier**： Code formatting
- **Axios**: Promise based HTTP client (encapsulated)
- **UnoCSS**: Real-time atomized CSS engine with high performance and flexibility
- **Mobile Compatible**: The layout is compatible with mobile page resolution
## Functions
- **User management**: log in, log out of the demo
- **Authority management**: Built-in page permissions (dynamic routing), instruction permissions, permission functions
- **Multiple Environments**: Development, Staging, Production
- **Multiple themes**: Normal, Dark, Dark Blue, theme modes
- **Multiple layouts**：Built-in left, top, left-top three layout modes
- **Error page**: 403, 404
- **Dashboard**: Display different Dashboard pages according to different users
- **Other functions**：SVG, Dynamic Sidebar, Dynamic Breadcrumb Navigation, Tabbed Navigation, Screenfull, Adaptive Shrink Sidebar, HooK (Composables)
## 🚀 Development
```bash
# configure
1. installation of the recommended plugins in the .vscode directory
2. node version 18.x or 20+
3. pnpm version 8.x or latest
# clone
git clone https://github.com/un-pany/v3-admin-vite.git
# enter the project directory
cd v3-admin-vite
# install dependencies
pnpm i
# start the service
pnpm dev
```
## ✔️ Preview
```bash
# stage environment
pnpm preview:stage
# prod environment
pnpm preview:prod
```
## 📦️ Multi-environment packaging
```bash
# build the stage environment
pnpm build:stage
# build the prod environment
pnpm build:prod
```
## 🔧 Code inspection
```bash
# code formatting
pnpm lint
# unit test
pnpm test
```
## Git commit specification reference
- `feat` add new functions
- `fix` Fix issues/bugs
- `perf` Optimize performance
- `style` Change the code style without affecting the running result
- `refactor` Re-factor code
- `revert` Undo changes
- `test` Test related, does not involve changes to business code
- `docs` Documentation and Annotation
- `chore` Updating dependencies/modifying scaffolding configuration, etc.
- `workflow` Work flow Improvements
- `ci` CICD
- `types` Type definition
- `wip` In development
## Project preview
![preview1.png](./src/assets/docs/preview1.png)
![preview2.png](./src/assets/docs/preview2.png)
![preview3.png](./src/assets/docs/preview3.png)
## 💕 Contributors
Thanks to all the contributors!
<a href="https://github.com/un-pany/v3-admin-vite/graphs/contributors">
<img src="https://contrib.rocks/image?repo=un-pany/v3-admin-vite" />
</a>
## 💕 Thanks star
Small projects are not easy to get a star, if you like this project, welcome to support a star! This is the only motivation for the author to maintain it on an ongoing basis (whisper: it's free after all)
## ☕ Donate
[See how to donate](https://github.com/un-pany/v3-admin-vite/issues/69)
## Group
QQ group：1014374415 (left) && add me on WeChat，Invite you to join WeChat group (right)
![qq.png](./src/assets/docs/qq.png)
![wechat.png](./src/assets/docs/wechat.png)
## 📄 License
[MIT](./LICENSE)
Copyright (c) 2022-present [pany](https://github.com/pany-ang)

150
README.md
View File

@@ -1,163 +1,65 @@
<div align="center">
<img alt="V3 Admin Vite Logo" width="120" height="120" src="./src/assets/layouts/logo.png">
<h1>V3 Admin Vite</h1>
<span>English | <a href="./README.zh-CN.md">中文</a></span>
</div>
## ⚡ Introduction
## ⚡ 简介
V3 Admin Vite is a free and open source middle and background management system basic solution, based on mainstream framework such as Vue3, TypeScript, Element Plus, Pinia and Vite
Ohmyweb是基于Ohmydns的工具对应的前端展示界面的封装，主要用于IPv6 DNS测绘结果的展示，基于 Vue3、TypeScript、Element Plus、Pinia 和 Vite 等主流技术
- Vue Cli 5.x: [v3-admin](https://github.com/un-pany/v3-admin)
- Electron desktop: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
- Vue Cli 5.x 版: [v3-admin](https://github.com/un-pany/v3-admin)
- Electron 桌面版: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
China repository: [Gitee](https://gitee.com/un-pany/v3-admin-vite)
## 📚 文档
## 📚 Document
- 中文文档：[链接](https://juejin.cn/post/7089377403717287972)
- 手摸手教程：[链接](https://juejin.cn/column/7207659644487139387)
- Chinese documentation: [link](https://juejin.cn/post/7089377403717287972)
- Chinese getting started tutorial: [link](https://juejin.cn/column/7207659644487139387)
## 📺 Online preview
| Location | account | Link |
| ------------ | ------------------- | ----------------------------------------------- |
| github-pages | `admin` or `editor` | [link](https://un-pany.github.io/v3-admin-vite) |
## ❤️ Generate electricity with love
- **Completely free**：But hopefully you order a star !!!
- **Very concise**：No complicated encapsulation, no complicated type gymnastics, out of the box
- **Detailed annotations**：Each configuration item is written with as detailed comments as possible
- **Latest dependencies**: Regularly update all third-party dependencies to the latest version
- **Very specification**: The code style is unified, the naming style is unified, and the comment style is unified
## Feature
- **Vue3**：The latest Vue3 composition API using Vue3 + script setup
- **Element Plus**：Vue3 version of Element UI
- **Pinia**: An alternative to Vuex in Vue3
- **Vite**：Really fast
- **Vue Router**：router
- **TypeScript**：JavaScript With Syntax For Types
- **PNPM**：Faster, disk space saving package management tool
- **Scss**：Consistent with Element Plus
- **CSS variable**：Mainly controls the layout and color of the item
- **ESlint**：Code verification
- **Prettier**： Code formatting
- **Axios**: Promise based HTTP client (encapsulated)
- **UnoCSS**: Real-time atomized CSS engine with high performance and flexibility
- **Mobile Compatible**: The layout is compatible with mobile page resolution
## Functions
- **User management**: log in, log out of the demo
- **Authority management**: Built-in page permissions (dynamic routing), instruction permissions, permission functions
- **Multiple Environments**: Development, Staging, Production
- **Multiple themes**: Normal, Dark, Dark Blue, theme modes
- **Multiple layouts**：Built-in left, top, left-top three layout modes
- **Error page**: 403, 404
- **Dashboard**: Display different Dashboard pages according to different users
- **Other functions**：SVG, Dynamic Sidebar, Dynamic Breadcrumb Navigation, Tabbed Navigation, Screenfull, Adaptive Shrink Sidebar, HooK (Composables)
## 🚀 Development
## 🚀 开发
```bash
# configure
1. installation of the recommended plugins in the .vscode directory
2. node version 18.x or 20+
3. pnpm version 8.x or latest
# 配置
1. 一键安装 .vscode 目录中推荐的插件
2. node 版本 18.x 或 20+
3. pnpm 版本 8.x 或最新版
# clone
# 克隆项目
git clone https://github.com/un-pany/v3-admin-vite.git
# enter the project directory
# 进入项目目录
cd v3-admin-vite
# install dependencies
# 安装依赖
pnpm i
# start the service
# 启动服务
pnpm dev
```
## ✔️ Preview
## ✔️ 预览
```bash
# stage environment
# 预览预发布环境
pnpm preview:stage
# prod environment
# 预览正式环境
pnpm preview:prod
```
## 📦️ Multi-environment packaging
## 📦️ 多环境打包
```bash
# build the stage environment
# 构建预发布环境
pnpm build:stage
# build the prod environment
# 构建正式环境
pnpm build:prod
```
## 🔧 Code inspection
## 🔧 代码检查
```bash
# code formatting
# 代码格式化
pnpm lint
# unit test
# 单元测试
pnpm test
```
## Git commit specification reference
- `feat` add new functions
- `fix` Fix issues/bugs
- `perf` Optimize performance
- `style` Change the code style without affecting the running result
- `refactor` Re-factor code
- `revert` Undo changes
- `test` Test related, does not involve changes to business code
- `docs` Documentation and Annotation
- `chore` Updating dependencies/modifying scaffolding configuration, etc.
- `workflow` Work flow Improvements
- `ci` CICD
- `types` Type definition
- `wip` In development
## Project preview
![preview1.png](./src/assets/docs/preview1.png)
![preview2.png](./src/assets/docs/preview2.png)
![preview3.png](./src/assets/docs/preview3.png)
## 💕 Contributors
Thanks to all the contributors!
<a href="https://github.com/un-pany/v3-admin-vite/graphs/contributors">
<img src="https://contrib.rocks/image?repo=un-pany/v3-admin-vite" />
</a>
## 💕 Thanks star
Small projects are not easy to get a star, if you like this project, welcome to support a star! This is the only motivation for the author to maintain it on an ongoing basis (whisper: it's free after all)
## ☕ Donate
[See how to donate](https://github.com/un-pany/v3-admin-vite/issues/69)
## Group
QQ group：1014374415 (left) && add me on WeChat，Invite you to join WeChat group (right)
![qq.png](./src/assets/docs/qq.png)
![wechat.png](./src/assets/docs/wechat.png)
## 📄 License
[MIT](./LICENSE)
Copyright (c) 2022-present [pany](https://github.com/pany-ang)
```

163
README.zh-CN.md
View File

@@ -1,163 +0,0 @@
<div align="center">
<img alt="V3 Admin Vite Logo" width="120" height="120" src="./src/assets/layouts/logo.png">
<h1>V3 Admin Vite</h1>
<span><a href="./README.md">English</a> | 中文</span>
</div>
## ⚡ 简介
V3 Admin Vite 是一个免费开源的中后台管理系统基础解决方案，基于 Vue3、TypeScript、Element Plus、Pinia 和 Vite 等主流技术
- Vue Cli 5.x 版: [v3-admin](https://github.com/un-pany/v3-admin)
- Electron 桌面版: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
国内仓库：[Gitee](https://gitee.com/un-pany/v3-admin-vite)
## 📚 文档
- 中文文档：[链接](https://juejin.cn/post/7089377403717287972)
- 手摸手教程：[链接](https://juejin.cn/column/7207659644487139387)
## 📺 在线预览
| 位置 | 账号 | 链接 |
| ------------ | --------------- | ----------------------------------------------- |
| github-pages | admin 或 editor | [链接](https://un-pany.github.io/v3-admin-vite) |
## ❤️ 用爱发电
- **完全免费**：但希望你点一个 star ！！！
- **非常简洁**：没有复杂的封装，没有复杂的类型体操，开箱即用
- **详细的注释**：各个配置项都写有尽可能详细的注释
- **最新的依赖**: 定期更新所有三方依赖至最新版
- **有一点规整**: 代码风格统一，命名风格统一，注释风格统一
## 特性
- **Vue3**：采用 Vue3 + script setup 最新的 Vue3 组合式 API
- **Element Plus**：Element UI 的 Vue3 版本
- **Pinia**: 传说中的 Vuex5
- **Vite**：真的很快
- **Vue Router**：路由路由
- **TypeScript**：JavaScript 语言的超集
- **PNPM**：更快速的，节省磁盘空间的包管理工具
- **Scss**：和 Element Plus 保持一致
- **CSS 变量**：主要控制项目的布局和颜色
- **ESlint**：代码校验
- **Prettier**：代码格式化
- **Axios**：发送网络请求（已封装好）
- **UnoCSS**：具有高性能且极具灵活性的即时原子化 CSS 引擎
- **兼容移动端**: 布局兼容移动端页面分辨率
## 功能
- **用户管理**：登录、登出演示
- **权限管理**：内置页面权限（动态路由）、指令权限、权限函数、路由守卫
- **多环境**：开发环境（development）、预发布环境（staging）、正式环境（production）
- **多主题**：内置普通、黑暗、深蓝三种主题模式
- **多布局**：内置左侧、顶部、混合三种布局模式
- **错误页面**: 403、404
- **Dashboard**：根据不同用户显示不同的 Dashboard 页面
- **其他内置功能**：SVG、动态侧边栏、动态面包屑、标签页快捷导航、Screenfull 全屏、自适应收缩侧边栏、Hook（Composables）
## 🚀 开发
```bash
# 配置
1. 一键安装 .vscode 目录中推荐的插件
2. node 版本 18.x 或 20+
3. pnpm 版本 8.x 或最新版
# 克隆项目
git clone https://github.com/un-pany/v3-admin-vite.git
# 进入项目目录
cd v3-admin-vite
# 安装依赖
pnpm i
# 启动服务
pnpm dev
```
## ✔️ 预览
```bash
# 预览预发布环境
pnpm preview:stage
# 预览正式环境
pnpm preview:prod
```
## 📦️ 多环境打包
```bash
# 构建预发布环境
pnpm build:stage
# 构建正式环境
pnpm build:prod
```
## 🔧 代码检查
```bash
# 代码格式化
pnpm lint
# 单元测试
pnpm test
```
## Git 提交规范参考
- `feat` 增加新的业务功能
- `fix` 修复业务问题/BUG
- `perf` 优化性能
- `style` 更改代码风格, 不影响运行结果
- `refactor` 重构代码
- `revert` 撤销更改
- `test` 测试相关, 不涉及业务代码的更改
- `docs` 文档和注释相关
- `chore` 更新依赖/修改脚手架配置等琐事
- `workflow` 工作流改进
- `ci` 持续集成相关
- `types` 类型定义文件更改
- `wip` 开发中
## 项目预览图
![preview1.png](./src/assets/docs/preview1.png)
![preview2.png](./src/assets/docs/preview2.png)
![preview3.png](./src/assets/docs/preview3.png)
## 💕 贡献者
感谢所有的贡献者！
<a href="https://github.com/un-pany/v3-admin-vite/graphs/contributors">
<img src="https://contrib.rocks/image?repo=un-pany/v3-admin-vite" />
</a>
## 💕 感谢 Star
小项目获取 star 不易，如果你喜欢这个项目的话，欢迎支持一个 star！这是作者持续维护的唯一动力（小声：毕竟是免费的）
## ☕ Donate
[查看捐赠方式](https://github.com/un-pany/v3-admin-vite/issues/69)
## 可有可无的群
QQ 群：1014374415（左）&& 加我微信，拉你进微信群（右）
![qq.png](./src/assets/docs/qq.png)
![wechat.png](./src/assets/docs/wechat.png)
## 📄 License
[MIT](./LICENSE)
Copyright (c) 2022-present [pany](https://github.com/pany-ang)