1 Star 0 Fork 0

Peak / PeakBlog-Admin

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

简介

Peak-Vue3-Admin 是一个以 vue-admin-template 为基础框架升级,整合了各种后台项目的优点对移动端有一定的适配,并对项目整体进行了大量逻辑、结构、样式的重构和梳理,具备了一定规范的模块化开发,项目使用了 Vite3、Vue3、TypeScript、Pinia、Element-Plus 等目前最新技术栈开发,基于 mock 实现本地数据模拟具备规范接口请求,本项目对代码进行了大量的代码说明以及对样式的分析和注释,大大降低了开发和学习的成本,既可以学习又可以基于模板功能二次开发。

功能

  • 使用 Vite3 构建项目、Vue3 + TypeScript 并使用了 setup 语法糖方式书写
  • 支持 i18n 国际化、页面结构主题配置等
  • 完备的登录流程以及用户的权限校验、动态路由权限拦截、页面按钮权限
  • 本地 mock 数据,高效规范开发
  • ThreeJS 加载 fbx 模型组件
  • 表格单行校验和统一校验,后续会增加结合表单等动态校验场景
  • 仿掘金评论区结构(模拟评论区所需数据结构)
  • 拖动组件,ECharts 可视化图表封装切换
  • 功能模块不断迭代增加...

代码仓库

演示地址

安装

[^注意事项]: node 版本 16 以上

git clone https://gitee.com/Iontheroad/peak-vue3-admin.git
npm install
npm run dev

分支管理

处于开发状态,预览项目请切换 dev_zgf

  • main: 最终预览版(代码相对 dev_zgf 落后较大)
  • dev_zgf: 功能开发迭代分支(最新)
  • pages: 静态资源部署

规范 TODO

任务相关:

  • BUG: 用来标记 BUG 或者问题~

  • FIXME: 用来标记一些需要修复的位置,可以快速定位(已知的无法运行的代码)。

  • TODO: 用来标记待办的地方,当天没有完成第二天需要继续的任务。

  • NOTE: 添加一些说明文字。

  • TAG: 用来创建一些标记。

  • RESOLVED:已解决的 bug 等问题。

优化和改进相关:

  • HACK: 用来标记可能需要更改的地方。在写代码的时候,有的地方我们并不确定他是正确的,可能未来有所更改,这时候可以使用 HACK 标记。

  • XXX: 用来标记一些草率实现的地方。在写代码的时候,有些地方需要频繁修改,这时候使用 XXX 标记。

  • OPTIMIZE: 需要优化的代码或需要进一步优化的方案。

  • QUESTION: 标记需要回答的问题或需要进一步确认的事项。

  • IDEA: 代码中的新想法或新方案,需要进一步讨论或实现。

Git 提交规范

Git 提交规范可以使用以下格式:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

其中,<type><subject>是必填项,其他为可选项。

  • <type>:提交的类型,建议使用以下类型之一:

    • feat:新功能
    • fix:修复问题
    • docs:修改文档
    • style:修改代码格式,不影响代码逻辑
    • refactor:重构代码,既不修复问题也不添加新功能
    • test:添加或修改测试代码
    • chore:修改构建流程或辅助工具
  • <scope>:修改的范围,可以是文件名、模块名等等

  • <subject>:简短描述修改的内容

  • <body>:详细描述修改的内容,可以分多行

  • <footer>:一些备注信息,例如关联的 issue 编号等

例如:

feat(login): 添加邮箱登录功能
添加了用户可以使用邮箱登录的功能,同时更新了登录页面的UI
Closes #123

这样的提交规范可以帮助团队更好地管理和维护代码库,提高代码质量和可读性。

提交示例

在命令行中提交使用这种规范,可以先在本地仓库中进行修改和提交,然后使用以下命令进行提交:

git commit -m "<type>(<scope>): <subject>" -m "<body>" -m "<footer>"

其中,-m选项表示提交信息中的一行,需要使用多次-m选项来添加多行信息。

例如,我们使用以下命令提交一个新功能的修改:

git commit -m "feat(login): 添加邮箱登录功能" -m "添加了用户可以使用邮箱登录的功能,同时更新了登录页面的UI." -m "Closes #123"

这样就可以将修改提交到本地仓库中了。如果需要将修改推送到远程仓库,可以使用git push命令。

MIT License Copyright (c) 2023 Peak Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

博客管理端 展开 收起
TypeScript 等 5 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
TypeScript
1
https://gitee.com/Iontheroad/peak-blog-admin.git
git@gitee.com:Iontheroad/peak-blog-admin.git
Iontheroad
peak-blog-admin
PeakBlog-Admin
master

搜索帮助