README文档模板

🙈作者简介：练习时长两年半的Java up主
🙉个人主页：程序员老茶
🙊 ps:点赞👍是免费的，却可以让写博客的作者开兴好久好久😎
📚系列专栏：Java全栈，计算机系列（火速更新中）
💭 格言：种一棵树最好的时间是十年前，其次是现在
🏡动动小手，点个关注不迷路，感谢宝子们一键三连

课程名：Java
- 内容/作用：知识点/设计/实验/作业/练习
- 学习：README文档
README文档
项目简介
- 应用场景
- 功能特性
- 业务架构
- 核心技术
- 项目端口
- - 后端端口
  - 前端端口
环境部署
- 准备工作
- 运行系统
- - 后端运行
  - 前端运行
  - 必要配置
- 部署系统
- - 后端部署
  - 前端部署
项目介绍
- 文件结构
- - 后端结构
  - 前端结构
部分演示图，持续更新
版权声明

课程名：Java

内容/作用：知识点/设计/实验/作业/练习

学习：README文档

README文档

项目简介

scanner -------- 后端
scanner-web ---- 前端

该项目为xxx。该系统后端采用springboot框架，前端采用Vue 3+Vant 4框架。可扩展性强。

应用场景

用于xxx。

功能特性

xxx
xxx
xxx
xxx
xxx（待开发）

业务架构

严格的分层来保证架构的灵活性

核心技术

前端技术栈：Vue 3,Vant 4,Axios…
后端技术栈：SQL serve,SpringBoot,MyBatis…

项目端口

后端端口

项目端口号可在文件：application.yaml 中更改。
默认端口号：xxx

前端端口

项目端口号可在文件：vite.config.ts 中更改。
默认端口号：xxx

环境部署

准备工作

JDK = 8
MySQL >= 5.7
SQLserve = 18
Node.js >= 10

运行系统

后端运行

run

前端运行

npm install
npm run dev
npm run build

必要配置

部署系统

后端部署

前端部署

项目介绍

文件结构

.
├── scanner------------------------------------------ 后端代码
└── scanner-web-------------------------------------- 前端代码

后端结构

.
├── java.com.jzj
│   └──scanner--------------------------------------- 核心应用目录
│       ├── config----------------------------------- 配置类
│       ├── controller------------------------------- 控制层
│       ├── domain----------------------------------- 实体
│       ├── mapper----------------------------------- 接口
│       ├── service---------------------------------- 服务层
│       ├── utils------------------------------------ 工具包
│       └── SacnnerApplication----------------------- 启动类
├── resources
│       ├── config----------------------------------- 配置
│       ├── imags------------------------------------ 图片
│       ├── mapper----------------------------------- SQL
│       ├── static----------------------------------- 静态资源
│       ├── templates-------------------------------- templates
│       ├── application.yaml------------------------- 配置文件
│       └── favicon.ico------------------------------ ico
├── target
├── HElP.md
├── mvnw
├── mvnw.cmd
├── pom.xml
├── README.MD
└── scanner.iml

前端结构

.
├── README.md------------------------------------------- 项目说明
├── jest.config.js
├── jsconfig.json
├── package.json
├── postcss.config.js
├── public
│   └── favicon.ico-------------------------------------- 浏览器icon
├── src
│   ├── App.vue----------------------------------------- Vue 模板入口
│   ├── api--------------------------------------------- Api Axios 等
│   ├── assets------------------------------------------ 本地静态资源
│   ├── components-------------------------------------- 业务通用组件
│   ├── main.js----------------------------------------- Vue 入口 JS
│   ├── router------------------------------------------ Vue-Router
│   ├── utils------------------------------------------- 工具库
│   └── views------------------------------------------- 业务页面入口和常用模板
├── vue.config.js--------------------------------------- Vue主配置
└── webstorm.config.js---------------------------------- ide配置文件