50 lines
2.2 KiB
Markdown
50 lines
2.2 KiB
Markdown
|
# “某某”系统
|
|||
|
|
|
|||
|
|
## 系统功能
|
|||
|
|
|
|||
|
|
（简要描述本项目有哪些功能，做什么的）
|
|||
|
|
|
|||
|
|
## 技术架构
|
|||
|
|
|
|||
|
|
| 技术 | 名称 | 官网 |
|
|||
|
|
| ------------ | -------------------- | --------------------------------------------- |
|
|||
|
|
| Spring Boot | 容器框架 | https://spring.io/projects/spring-boot |
|
|||
|
|
| Apache Shiro | 安全框架 | http://shiro.apache.org |
|
|||
|
|
| MyBatis-Plus | ORM框架 | https://baomidou.com |
|
|||
|
|
| Druid | 数据库连接池 | https://github.com/alibaba/druid |
|
|||
|
|
| Redis | 分布式缓存数据库 | https://redis.io |
|
|||
|
|
| EasyExcel | 读写Excel | https://www.yuque.com/easyexcel/doc/easyexcel |
|
|||
|
|
| Forest | Java HTTP 客户端框架 | https://forest.dtflyx.com/docs |
|
|||
|
|
| Maven | 项目构建管理 | http://maven.apache.org |
|
|||
|
|
|
|||
|
|
## 工程目录
|
|||
|
|
|
|||
|
|
```lua
|
|||
|
|
/project-name
|
|||
|
|
├── db --存放pdm库表结构，字典数据sql等
|
|||
|
|
├── src/main/java
|
|||
|
|
├── com.chinaweal.youfool.pms --父包
|
|||
|
|
├── config --配置存放包
|
|||
|
|
├── dev --开发辅助main入口
|
|||
|
|
├── entwx --企业微信模块功能
|
|||
|
|
├── system --系统模板功能
|
|||
|
|
├── util --工具包
|
|||
|
|
├── schedule -- 定时任务包
|
|||
|
|
├── ......
|
|||
|
|
├── src/main/resources --项目配置文件
|
|||
|
|
├── checkstyle-v1.0.xml --代码规范检查
|
|||
|
|
├── ......
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 运行方式
|
|||
|
|
|
|||
|
|
1. 使用IntelliJ IDEA 工具，选择打开项目工程
|
|||
|
|
2. 更新maven依赖，一般工具打开会自动更新。也可以手动运行`mvn compile`命令主动刷新并构建
|
|||
|
|
3. 检查`application.yml`中的`spring.profiles.active`属性值是否符合当前运行环境
|
|||
|
|
4. 点击运行`com.chinaweal.youfool.pms.YoufoolPmsApplication.class`类下面的`main`方法即可
|
|||
|
|
|
|||
|
|
## 部署方式
|
|||
|
|
|
|||
|
|
1. 检查`application.yml`中的`spring.profiles.active`属性值是否符合部署环境信息
|
|||
|
|
2. 运行`mvn clean package`命令打war包
|
|||
|
|
3. 打包成功后，会生成`/target/youfool-pms.war`部署应用包
|