# mb-admin **Repository Path**: shanyi-hui/mb-admin ## Basic Information - **Project Name**: mb-admin - **Description**: Micro Build Admin - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-04-26 - **Last Updated**: 2025-05-07 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README


[![license](https://img.shields.io/github/license/syh-micro-build/mb-admin.svg)](LICENSE) [![repo-size](https://img.shields.io/github/repo-size/syh-micro-build/mb-admin.svg)](repo-size) [![last-commit](https://img.shields.io/github/last-commit/syh-micro-build/mb-admin.svg)](last-commit) [![stars](https://img.shields.io/github/stars/syh-micro-build/mb-admin.svg)](stars) [![forks](https://img.shields.io/github/forks/syh-micro-build/mb-admin.svg)](forks) [![release](https://img.shields.io/github/release/syh-micro-build/mb-admin.svg)](release) [![watchers](https://img.shields.io/github/watchers/syh-micro-build/mb-admin.svg)](watchers)

mb-admin

## 介绍 mb-admin 是一个基于 `element-plus` 免费开源的中后台模版。使用了最新的`vue3`,`vite`,`TypeScript`等主流技术开发,开箱即用的中后台前端解决方案,可以用来作为项目的启动模版,也可用于学习参考。并且时刻关注着最新技术动向,尽可能的第一时间更新。 mb-admin 的定位是后台集成方案,不太适合当基础模板来进行二次开发。因为集成了很多你可能用不到的功能,会造成不少的代码冗余。如果你的项目不关注这方面的问题,也可以直接基于它进行二次开发。 ### 生态 - [mb-cli](https://github.com/syh-micro-build/mb-cli?tab=readme-ov-file): Micro Build 生态中的脚手架工具。主要用于创建和发布 Micro Build 中的组件、模块或应用,为开发人员生成模板,使其专注于核心业务开发并快速产出上线,同时它具备对接大型代码托管平台的能力(官方默认支持GitHub,GitLab 及 Gitee)。 ## 特性 - **最新技术栈**:使用 Vue3 + vite5 + vueRouter + pina 等前端前沿技术开发 - **TypeScript**: 应用程序级 JavaScript 的语言 - **主题**: 可配置的主题 - **自定义数据** 内置 Mock 数据方案 - **权限** 内置完善的动态路由权限生成方案 - **组件** 二次封装了多个常用的组件 - **示例** 内置丰富的示例 ## 预览 #### [在线预览(国际地址)👈](https://admin.mbuild.top) #### [在线预览(国内地址)👈](http://shanyi-hui.gitee.io/mb-admin) *帐号密码:admin / admin* ## 官方文档 #### [官方文档(国际地址)👈](https://admindoc.mbuild.top) #### [官方文档(国内地址)👈](https://shanyi-hui.gitee.io/mb-admin-doc/) ## 前序准备 - [node](http://nodejs.org/) 和 [git](https://git-scm.com/) - 项目开发环境 - [Vite](https://vitejs.dev/) - 熟悉 vite 特性 - [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法 - [TypeScript](https://www.typescriptlang.org/) - 熟悉 `TypeScript` 基本语法 - [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法 - [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用 - [Element-Plus](https://element-plus.org/) - element-plus 基本使用 - [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法 - [UnoCSS](https://unocss.dev/) - 熟悉 UnoCSS 即时按需原子 CSS 引擎 ## 安装和使用 - 获取代码 ```bash git clone https://github.com/syh-micro-build/mb-admin.git ``` - 安装依赖 ```bash cd mb-admin npm install npm run prepare ``` - 运行 ```bash npm run dev ``` - 打包 ```bash # 开发环境 npm run build dev # 测试环境 npm run build test # 生产环境 npm run build pro ``` - 打包后预览 ```bash # 开发环境 npm run preview dev # 测试环境 npm run preview test # 生产环境 npm run preview pro ``` - 提交代码 ```bash git add . npx cz ``` - 版本更新 ```bash npm run release ``` - 项目依赖更新 ```bash npm run npm-check ``` ## 更新日志 [更新日志](./CHANGELOG.md) ## 如何贡献 你可以[提一个 issue](https://github.com/syh-micro-build/mb-admin/issues/new) 或者提交一个 Pull Request。 **Pull Request:** 1. Fork 代码 2. 创建自己的分支: `git checkout -b feat/xxxx` 3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'` 4. 推送您的分支: `git push origin feat/xxxx` 5. 提交 `pull request` ## Git 贡献提交规范 - `feat`: ✨ 新增功能 | A new feature' - `fix`: 🐛 修复缺陷 | A bug fix' - `docs`: 📝 文档更新 | Documentation only changes' - `style`: 💄 代码格式 | Changes that do not affect the meaning of the code' - `refactor`: ♻️ 代码重构 | A code change that neither fixes a bug nor adds a feature' - `perf`: ⚡️ 性能提升 | A code change that improves performance' - `test`: ✅ 测试相关 | Adding missing tests or correcting existing tests' - `build`: 📦️ 构建相关 | Changes that affect the build system or external dependencies' - `ci`: 🎡 持续集成 | Changes to our CI configuration files and scripts' - `chore`: 🔨 其他修改 | Other changes that do not modify src or test files' - `revert`: ⏪️ 回退代码 | Revert to a commit' ## 浏览器支持 本地开发推荐使用 `Chrome 80+` 浏览器 支持现代浏览器, 不支持 IE | [ Edge](http://godban.github.io/browsers-support-badges/)
IE | [ Edge](http://godban.github.io/browsers-support-badges/)
Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | | :-: | :-: | :-: | :-: | :-: | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | ## 捐赠 捐赠开源,让技术照亮更多人的未来~~~ - 支付宝 - 微信 ## 技术交流 欢迎大家加入技术交流群,探讨技术,一起进步~~~ - qq群:415849653 - 微信群 ## 许可证 [MIT](./LICENSE)