增加README文件

This commit is contained in:
lr 2022-05-26 20:43:46 +08:00
parent 6d8259e640
commit d8244dbdb2
1 changed files with 68 additions and 0 deletions

68
README.md Normal file
View File

@ -0,0 +1,68 @@
<h1 align="center">likeadmin通用管理后台JAVA版本</h1>
<h4 align="center">📈快速开发前后端解决方案</h4>
<p align="center">
<a href="https://www.java.com/zh-CN/download/"><img src="https://img.shields.io/badge/JAVA-8.0-d74f11"> </a><a href="#"> <img src="https://img.shields.io/badge/Spring Boot-2.5-5e
a931"> </a><a href="https://www.tslang.cn/"><img src="https://img.shields.io/badge/TypeScript-3.1-294e80"> </a><a href="#"><img src="https://img.shields.io/badge/Vue.js-3.2-4eb883"> </a><a href="#"><img src="https://img.shields.io/badge/vite-2.0.0-ffc018"> </a><a href="#"><img src="https://img.shields.io/badge/Element Plus-1.2.0-409eff"> </a>
<div align="center">
<img width="80%" src="https://md.likeshop.cn/server/index.php?s=/api/attachment/visitFile&sign=f4dc6a16c63dac26da3017979e818802" />
</div>
<br>
# 👨‍💻‍ 简介
<a href="https://gitee.com/likeshop_gitee">likeshop开源团队</a>基于以往开源产品的经验希望能够为开源社区做出更多的贡献推出永久免费开源的likeadmin通用前后端分离管理后台系统。遵循Apache2开源许可协议您可以免费使用甚至允许把你基于likeadmin开发的软件应用开源、发布、销售。
<br>
### 🏀 联系我们
likeadmin官网https://www.likeadmin.cn/
likeadmin交流群QQ629475409
<br>
# 🧐 进一步了解
### 🧰 场景介绍
1.likeadmin已经搭建好前后端分离的底层包含程序安装、登录、登出、工作台、菜单权限控制、角色、管理员、网站设置、图库管理等基础功能无需重复造轮子。<br>
2.可视化系统程序安装界面,可自定义安装数据,开发者可快速扩展发行自己的软件产品。<br>
3.likeadmin定位为通用的软件系统管理后台方便开发者快速开发软件系统文档清晰、代码易懂、简单易用。<br>
4.未来将持续集成通用的微信/支付宝支付,阿里云/腾讯云短信,阿里云/腾讯云OSS等通用模块。
### 🐙 后端架构方面
1.服务端使用JAVA8开发性能有突破性的提升。<br>
2.使用Spring Boot2.5框架目前国内流行的JAVA框架高性能、简单易用、文档齐全、支持Mave高级项目管理工具、支持Redis等。
### 🐹 前端架构方面
1.使用最流性的前后端分离方案typescript、vue3、vite开发保持了代码的简洁、一致和规范。<br>
2.后台界面使用element-plus UI框架简单精美的后台界面丰富的组件库方便快速开发满足各种后台交互。
<br>
# 📄 文档
## ⚙️项目部署
#### 环境安装
下载并安装:[JDK1.8](https://www.java.com/zh-CN/download/ "JDK1.8")、Maven 3.8.*、Mysql5.7
#### 数据库配置
1.登录mysql创建编码为utf8mb4的数据库导入/sql/install.sql文件数据库创建完毕。<br>
2.复制/like-framework/like-admin/src/main/resources/application-example-pro.yml文件为/like-framework/like-admin/src/main/resources/application-pro.yml打开application-pro.yml文件修改url项的地址为数据库ip地址地址“/”后面为数据库名称username项为数据库账号password项为数据密码然后保存。
![](https://md.likeshop.cn/server/index.php?s=/api/attachment/visitFile&sign=640156ad1b5b55defef7b0418e700a99)
#### 构建项目
打开终端使用cd命令进入\like-framework目录运行 `mvn install`,构建项目。
![](https://md.likeshop.cn/server/index.php?s=/api/attachment/visitFile&sign=04c5085ee95cc58bf7e85e1ecd87c564)
#### 运行项目
打开终端使用cd命令进入\like-framework\like-admin目录运行“mvn spring-boot:run”。
![](https://md.likeshop.cn/server/index.php?s=/api/attachment/visitFile&sign=3db66d7e51c1d6f0d1fadee6083f7c80)<br>
打开浏览器访问http://127.0.0.1:8082 ,即可看到接口返回信息。
![](https://md.likeshop.cn/server/index.php?s=/api/attachment/visitFile&sign=e9fc7af2de10c504219cd762f88d72ec)<br>
### 📁 目录结构
```shell
├─📂admin //管理后台前端源码
├─📂frontend // //前端已编译代码目录(入口目录、上线运行)
├─📂like-framework //java项目目录编辑器、IDE打开此目录
│ │ ├─📂like-admin //管理后台模块
│ │ ├─📂like-common //公共模块
│ │ ├─📂like-front //前台模块
├─📂sql //项目数据库结构
```
### 🪐接口文档
[点击这里进入更多更详细文档。](https://www.likeadmin.cn "点击这里进入更多更详细文档。")