diff --git a/README.md b/README.md index 5710a368aa7a0b6124bfb489ccd3b7abd3b4a87c..7d9d345d522a7171a6e281e5b492ca3a6a28cf1f 100644 --- a/README.md +++ b/README.md @@ -1,147 +1,81 @@ -
-
- -

BuildAdmin

-

使用流行技术栈快速创建商业级后台管理系统

- 官网 | - 演示 | - 社区 | - 文档 | - 加群 | - 视频介绍 | - Gitee仓库 | - GitHub仓库 -
-
-

- - vue - - - vue - - - element plus - - - typescript - - - vite - - - vite - - - license - -

- -
-
- -
-
- -### 介绍 -🌈 基于 Vue3.x + ThinkPHP8 + TypeScript + Vite + Pinia + Element Plus 等流行技术栈的后台管理系统，支持常驻内存运行、可视化 CRUD 代码生成、自带 WEB 终端、自适应多端、同时提供 Web、WebNuxt、Server 端，内置全局数据回收站和字段级数据修改保护、自动注册路由、无限子级权限管理等，无需授权即可免费商用，希望能帮助大家实现快速开发。 - -✨ 关于 `Star` 的小小期待 ✨ - -~~文档和演示站的「入场券」是点亮 Star~~ 哈哈哈，开个玩笑，实际上**您不需要任何「门槛」即可访问源码、文档和演示站**，在您丝滑体验文档与强大功能的同时，我们有个温暖的请求 —— 若 `BuildAdmin` 让您眼前一亮，请为我们点亮一颗 `Star`，这将是一次开发者间最浪漫的「确认过眼神」，亦可助我们向本应「自由开放」的开源界证明：优秀的项目我会发自内心的点亮 Star ~（而不是像某些同类产品哪样，将 Star 作为文档或演示站的「强制交换」条件） - -### 主要特性 -**🚀 CRUD 代码生成：** -图形化拖拽生成后台增删改查代码，自动创建数据表；大气且实用的表格，多达 24 种表单组件支持，行拖拽排序，受权限控制的编辑和删除等等，并支持关联表，可为您节省大量开发时间。 - -**💥 内置 WEB 终端：** -在后台管理系统领域，我们率先将终端深度集成于系统的 `本地开发环境` 中，它能实现很多理想中的功能，比如：虽然是基于 Vue3 的系统，但在安装时并不需要手动的执行 `npm install` 命令；CRUD 代码生成完毕后，自动调用 `prettier` 格式化代码等。本终端设计上能够调用环境变量中的任意命令，天花板极高，后续将为您提供更多方便、快捷的服务。 - -**👍 流行且稳定的技术栈：** -除了基于 `ThinkPHP8` 前后端分离架构外，我们的 `Vue3` 使用了 `setup、useTemplateRef` 等，状态管理使用 `Pinia`，并使用了 `TypeScript、Vite` 等可以为你的知识面添砖加瓦的技术栈。使用流行技术栈自然代表本框架兼容相关（Vue3+TP8+PHP8.x）生态，生态系统内数不清的库、包、组件，能够使您的开发事半功倍。 - -**🎨 模块市场：** -一键安装数据导入导出、短信发送、支付、云存储、富文本编辑器，甚至 CMS、商城、社区、纯前端技术栈的学习案例项目等，随时随地为系统添砖加瓦，系统能够自动维护 `package.json` 和 `composer.json` 并通过内置终端自动完成模块所需依赖的安装。 - -**🔀 前后端分离：** -项目的 `web` 文件夹内包含： `干净`（不含后端代码）、`完整`（所有前端代码文件均在此内）的前端代码文件，代码和部署均可前后分离，对前端开发者友好，作为纯前端开发者，您可以将 BAdmin 当做学习与资源的社群，本系统可为您准备好案例和模板等所需要的环境，而您只需专注于学习或工作，不需要会任何后端代码！（邀您：[和我们一起](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=paVQA1dlpsVNHTla-ZAts6e4pPK4va9R&authKey=Eto0dq9DOuYldJPl6URFAXXHlG2AFQtPUBxNHEByEiuSg9OraxMniXIaWFt46OKi&noverify=0&group_code=1039646575) ） - -**⚡️ 常驻内存：** -系统内置的功能均可常驻内存运行，享受比传统框架快上数十倍的性能提升！目前 [Workerman 模块](https://modules.buildadmin.com/workerman) 可提供框架的常驻内存 `HTTP` 服务，同时该模块还提供了开箱即用的 `WebSocket` 服务。 - -**🚚 按需加载：** -前端的页面组件和语言包均是在使用到它们时，才从网络异步加载，服务端则是基于 `TP8` 和 `PSR` 规范，天生拥有真正的按需加载能力，所以，您无需考虑 `我并不需要多语言、我并不需要某个后台功能` 这类的问题，不需要不使用或隐藏即可。 - -**🌴 数据回收与反悔：** -内置全局数据回收站，并且提供字段级数据修改记录和修改对比，随时回滚和还原，安全且无感。 - -**✨ 高颜值：** -提供三种布局模式，其中默认布局使用无边框设计风格，它并没有强行填满屏幕的每一个缝然后使用边框线进行分隔，所有的功能版块，都像是悬浮在屏幕上的，同时又将屏幕空间及其合理的利用了。 - -**🔐 权限验证：** -可视化的管理权限，然后根据权限动态的注册路由、菜单、页面、按钮（权限节点）、支持无限父子级权限分组、前后端搭配鉴权，自由分派页面和按钮权限。 - -**📝 未来可期：** -我们正在持续维护系统，并着手开发更多基础设施模块，按需一键安装，甚至提供开箱即用的各行业完整应用。 - -**🧱 一举多得：** -后台自适应 PC、平板、手机 等多种场景的支持，轻松应对各种需求。 - -**💖 其他杂项：** -角色组/管理员/管理员日志、 会员/会员组/会员余额、积分日志、系统配置/控制台/附件管理/个人资料管理等等、更多特性等你探索... - -### 安装使用 -💫 我们提供了完善的文档，对于熟悉 `ThinkPHP` 和 `Vue` 的用户，请使用大佬版：[快速上手](https://doc.buildadmin.com/guide/install/start.html) ，对于新人朋友，我们额外准备了各个操作系统的从零开始套餐：[Windows从零到一](https://doc.buildadmin.com/guide/install/windows.html) | [Linux从零到一](https://doc.buildadmin.com/guide/install/linux-bt.html) | [MacBook安装引导](https://doc.buildadmin.com/guide/install/macBook.html) - -### 联系我们 -- [演示站](https://demo.buildadmin.com) 账户：`admin`，密码：`123456`（演示站数据无法修改，请下载源码安装体验全部功能） -- [问答社区：ask.buildadmin.com](https://ask.buildadmin.com) -- [官方网站：uni.buildadmin.com](https://uni.buildadmin.com) -- [文档：doc.buildadmin.com](https://doc.buildadmin.com/) -- 加群：[687903819（>960/1000）](https://jq.qq.com/?_wv=1027&k=QwtXa14c)、[751852082（>1990/2000）](https://jq.qq.com/?_wv=1027&k=c8a7iSk8)、[1039646575](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=paVQA1dlpsVNHTla-ZAts6e4pPK4va9R&authKey=Eto0dq9DOuYldJPl6URFAXXHlG2AFQtPUBxNHEByEiuSg9OraxMniXIaWFt46OKi&noverify=0&group_code=1039646575) -- [Gitee仓库](https://gitee.com/wonderful-code/buildadmin)、[GitHub仓库](https://github.com/build-admin/BuildAdmin) -- [官方邮箱 hi@buildadmin.com](mailto:hi@buildadmin.com) - -### 项目预览 -| | | -|---------------------|---------------------| -|![登录](https://doc.buildadmin.com/images/readme/login.gif)|![控制台](https://doc.buildadmin.com/images/readme/dashboard.png)| -|![布局配置](https://doc.buildadmin.com/images/readme/layout.png)|![表格](https://doc.buildadmin.com/images/readme/admin.png)| -|![表单](https://doc.buildadmin.com/images/readme/user.png)|![系统配置](https://doc.buildadmin.com/images/readme/config.png)| -|![数据回收规则](https://doc.buildadmin.com/images/readme/data-recycle.png)|![数据回收日志](https://doc.buildadmin.com/images/readme/data-recycle-log.png)| -|![敏感数据](https://doc.buildadmin.com/images/readme/sensitive-data.png)|![菜单](https://doc.buildadmin.com/images/readme/menu.png)| -|![单栏布局](https://doc.buildadmin.com/images/readme/layout-3.png)|![经典布局](https://doc.buildadmin.com/images/readme/layout-2.png)| - -### 特别鸣谢 -💕 感谢巨人提供肩膀，排名不分先后 -- [Thinkphp](http://www.thinkphp.cn/) -- [FastAdmin](https://gitee.com/karson/fastadmin) -- [Vue](https://github.com/vuejs/core) -- [vue-next-admin](https://gitee.com/lyt-top/vue-next-admin) -- [Element Plus](https://github.com/element-plus/element-plus) -- [TypeScript](https://github.com/microsoft/TypeScript) -- [vue-router](https://github.com/vuejs/vue-router-next) -- [vite](https://github.com/vitejs/vite) -- [Pinia](https://github.com/vuejs/pinia) -- [Axios](https://github.com/axios/axios) -- [nprogress](https://github.com/rstacruz/nprogress) -- [screenfull](https://github.com/sindresorhus/screenfull.js) -- [mitt](https://github.com/developit/mitt) -- [sass](https://github.com/sass/sass) -- [echarts](https://github.com/apache/echarts) -- [vueuse](https://github.com/vueuse/vueuse) -- [lodash](https://github.com/lodash/lodash) -- [eslint](https://github.com/eslint/eslint) -- [prettier](https://github.com/prettier/prettier) -- [Sortable](https://github.com/SortableJS/Sortable) -- [v-code-diff](https://github.com/Shimada666/v-code-diff) -- [clicaptcha](https://github.com/hooray/clicaptcha) -- [phinx](https://github.com/cakephp/phinx) -- [jetbrains](https://www.jetbrains.com/) - -### 版权信息 -🔐 BuildAdmin 遵循 `Apache2.0` 开源协议发布，提供无需授权的免费使用。\ -本项目包含的第三方源码和二进制文件之版权信息另行标注。 - -### 支持项目 -💕 无需捐赠，如果觉得项目不错，或者已经在使用了，希望你可以去 [Github](https://github.com/build-admin/BuildAdmin) 或者 [Gitee](https://gitee.com/wonderful-code/buildadmin) 帮我们点个 ⭐ Star，这将是对我们极大的鼓励与支持。 +# BuildAdmin 管理系统 + +## 介绍 +BuildAdmin 是一个基于 ThinkPHP6 和 Vue3 的前后端分离管理系统。它提供了丰富的功能模块和可视化界面，支持模块化开发和动态表单生成。 + +主要特性： +- 基于 RBAC 的权限控制系统 +- 可视化 crud 表单生成 +- 模块化管理系统 +- 数据回收站和敏感数据管理 +- 多语言支持（中英文） +- 响应式布局适配不同设备 +- 完善的用户中心功能 +- 强大的后台管理界面 + +## 安装使用 + +### 后端安装 +1. 确保服务器环境满足以下要求： + - PHP >= 8.0 + - MySQL >= 5.6 + - Nginx/Apache + +2. 将项目文件上传到服务器 + +3. 配置数据库信息： + ```bash + cp .env.example .env + # 编辑 .env 文件，配置数据库连接信息 + ``` + +4. 执行数据库迁移： + ```bash + php think migrate:run + php think migrate:run --path=database/migrations/20230620180916_install_data.php + ``` + +5. 配置 web 目录为网站根目录 + +### 前端安装 +1. 进入 web 目录： + ```bash + cd web + ``` + +2. 安装依赖： + ```bash + npm install + ``` + +3. 开发环境运行： + ```bash + npm run dev + ``` + +4. 生产环境构建： + ```bash + npm run build + ``` + +## 联系我们 +- 官方网站：https://gitee.com/wonderful-code/buildadmin +- 问题反馈：请在 Gitee 项目页面提交 issue +- 版本更新：定期查看 CHANGELOG.md 获取最新版本信息 + +## 项目预览 +[![BuildAdmin 预览图](public/static/images/login-header.png)](https://gitee.com/wonderful-code/buildadmin) + +## 特别鸣谢 +感谢以下开源项目的贡献： +- ThinkPHP6 +- Vue3 +- Element Plus +- TypeScript +- Vite + +## 版权信息 +本项目遵循 MIT 开源协议 + +## 支持项目 +您可以为项目点赞或提交 PR 来支持项目发展。我们欢迎任何形式的贡献！ \ No newline at end of file