java项目README.MD文件模板

java项目README.MD文件模板

项目简介：

用一两句话简单描述该项目所实现的业务功能；

技术选型:

• 后端技术栈

  • springboot
  • mybaits
  • jwt

• 数据库

  • 关系型数据库 mysql
  • 非关系型数据库 oracle

• 前端技术

  • vue
  • element-ui

• 中间件技术

  • redis
  • rabittmq
  • es

• 运维技术

  • 服务器 centos7
  • docker
  • 构建工具 maven

本地构建：

领域模型：

核心的领域概念，比如对于示例电商系统来说有Order、Product等；

测试策略：

自动化测试如何分类，哪些必须写测试，哪些没有必要写测试；

技术架构：

前后端分离

部署架构：

java =jar

外部依赖：

项目运行时所依赖的外部集成方，比如订单系统会依赖于会员系统；

环境信息：

dev

test

prod

编码实践:

统一的编码实践，比如异常处理原则、分页封装等；

FAQ：

1.启动报错redis未连接