From 5eddb4910c21c2ec550c4a88a95a656a7f7ecbcb Mon Sep 17 00:00:00 2001 From: Soybean Date: Thu, 20 Jan 2022 21:29:30 +0800 Subject: [PATCH] docs(projects): update README.md --- README.md | 125 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 123 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9be0b7fb..d51062e7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,124 @@ -# soybean-admin-thin +
+ +

Soybean Admin Thin

+
-soybean-admin重构版,新添加动态权限路由 +[![license](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE) + +## 简介 + +Soybean Admin Thin 是Soybean Admin的精简版。 + +## 特性 + +- **最新技术栈**:使用 Vue3/vite2 等前端前沿技术开发, 使用高效率的npm包管理器pnpm +- **TypeScript**: 应用程序级 JavaScript 的语言 +- **主题**:丰富可配置的主题 +- **代码规范**:丰富的规范插件及极高的代码规范 +- **路由配置**:简易的路由配置 + +## 预览 + +- [soybean-admin](https://soybean.pro/) + +## 文档 + +- [项目文档](https://docs.soybean.pro) + +### 代码仓库 + +- [github](https://github.com/honghuangdc/soybean-admin) + +- [gitee](https://gitee.com/honghuangdc/soybean-admin) + +## 项目示例图 +![](https://i.loli.net/2021/11/24/pIhTKP7fdCqbVHl.png) + +![](https://i.loli.net/2021/11/24/gxRwsLnKi6IVp7C.png) + +![](https://i.loli.net/2021/11/24/UmVfjSJbxH6iYc2.png) + +![](https://i.loli.net/2021/11/24/Uot1bcfGXiF726T.png) + +![](https://i.loli.net/2021/11/24/WzOIvlgJZaUtGm7.png) + +### 使用 Gitpod + +在 Gitpod(适用于 GitHub 的免费在线开发环境)中打开项目,并立即开始编码. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/honghuangdc/soybean-admin) + +## 安装使用 + +- 克隆代码 + +```bash +git clone https://github.com/honghuangdc/soybean-admin.git +``` + +- 安装依赖 + +```bash +pnpm i +``` + +- 运行 + +```bash +pnpm dev +``` + +- 打包 + +```bash +pnpm build +``` + +## 如何贡献 + +非常欢迎您的加入![提一个 Issue](https://github.com/honghuangdc/soybean-admin/issues/new) 或者提交一个 Pull Request。 + +## Git 贡献提交规范 + +项目已经内置angular提交规范,通过git cz 代替git commit 命令即可。 + +git cz命令需要全局安装 commitizen + +```bash +pnpm i -g commitizen +``` + +## 浏览器支持 + +本地开发推荐使用`Chrome 90+` 浏览器 + +支持现代浏览器, 不支持 IE + +| [IE](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 | + +## 开源作者 + +[@Soybean](https://github.com/honghuangdc) + +## 交流 + +`Soybean Admin` 是完全开源免费的项目,在帮助开发者更方便地进行中大型管理系统开发,同时也提供 QQ 交流群使用问题欢迎在群内提问。 + +- 微信交流群: +
+ +
+ +- QQ 群 `711301266` + +
+ +
+ +- 本人微信号:honghuangdc,欢迎来技术交流,业务咨询。 + +## License + +[MIT © Soybean-2021](./LICENSE)