From 72e907823603402779d2d52160206d2735737b6e Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 29 Aug 2025 01:51:01 +0000 Subject: [PATCH] Add README.md --- README.en.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 126 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..8e2ea9c --- /dev/null +++ b/README.en.md @@ -0,0 +1,63 @@ +This project is a front-end and back-end separated application based on Spring Boot and Vue.js, primarily designed to implement basic CRUD operations and interaction between the front-end and back-end. The project has a clear structure and is suitable for learning Spring Boot back-end development, Vue front-end development, and the basic workflow of integrated front-end and back-end debugging. + +## Project Structure Overview + +- **FirstSpringbootDemo**: A simple Spring Boot introductory project containing the startup class. +- **SecondBootDemo**: Contains multiple controllers (e.g., AnimalController, ProductController, UserController), used to demonstrate the creation of RESTful APIs and basic business logic. +- **VueDemo0827**: A front-end Vue project demonstrating how to interact with the back-end via Vue.js. +- **day0826, day0828homework, day0829**: Contains back-end business logic based on Spring Boot, such as customer management, movie management, etc. +- **springboot-vue-elementPlus**: A Vue front-end project using the Element Plus component library, enabling more complex interactions with the back-end. +- **springboot3-06-properties-location**: Demonstrates how to load configuration files from different locations in Spring Boot. + +## Key Functional Modules + +### Back-End Features + +- **RESTful API**: Provides standard create, read, update, and delete interfaces, such as `/addAnimal`, `/animalList`, `/updateAnimalByName`, `/deleteAnimalByName`, etc. +- **Swagger Integration**: Swagger is used in the `day0826` module to generate API documentation. +- **Database Operations**: MyBatis is used for database operations, such as `CustomerMapper`, `MovieMapper`, etc. +- **Configuration Management**: Demonstrates how to load configurations from `application.properties` and `application.yml` in the `springboot3-06-properties-location` module. + +### Front-End Features + +- **Vue.js**: Front-end development using Vue 3, implementing data binding and component-based development. +- **Axios**: Used for HTTP communication with the back-end. +- **Element Plus**: The Element Plus component library is used in the `springboot-vue-elementPlus` module to implement more visually appealing UI interactions. + +## Technology Stack + +- **Back-End**: Spring Boot, MyBatis, Swagger, Maven +- **Front-End**: Vue.js, Axios, Element Plus +- **Database**: No specific database is used in the project, but interfaces for database interaction are provided (e.g., Mapper classes). + +## Project Highlights + +- **Front-End and Back-End Separation**: The back-end provides RESTful APIs, and the front-end communicates with the back-end via Axios, implementing a front-end and back-end separated architecture. +- **Modular Design**: The project is divided into functional modules, making it easy to maintain and extend. +- **Documentation Support**: API documentation is generated using Swagger, facilitating collaborative development between front-end and back-end teams. +- **Configuration Management**: Supports loading configuration files from different locations, improving configuration flexibility. + +## How to Run the Project + +### Back-End Setup Instructions + +1. Ensure that JDK 1.8 or a later version is installed. +2. Import the project into an IDE (e.g., IntelliJ IDEA). +3. Run the `Application` class in the Spring Boot module to start the project. +4. Visit `http://localhost:8080` to view the API documentation (if Swagger is configured). + +### Front-End Setup Instructions + +1. Ensure that Node.js and npm are installed. +2. Navigate to the `VueDemo0827` or `springboot-vue-elementPlus` directory. +3. Run `npm install` to install dependencies. +4. Run `npm run serve` to start the development server. +5. Visit `http://localhost:8080` to view the front-end page. + +## Project Purpose + +This project is primarily designed for learning the basics of Spring Boot and Vue.js, as well as how to implement data interaction in a front-end and back-end separated architecture. It is suitable for beginners to master RESTful API design, Vue.js fundamentals, Axios usage, and integration of the Element Plus component library. + +## Contributors + +This project is maintained by an individual developer and is suitable for learning and experimentation. Issues and Pull Requests are welcome to help improve the project. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..40a00b3 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +该项目是一个基于Spring Boot和Vue.js的前后端分离应用，主要用于实现基础的CRUD操作和前后端交互。项目结构清晰，适合学习Spring Boot后端开发、Vue前端开发以及前后端联调的基本流程。 + +## 项目结构概览 + +- **FirstSpringbootDemo**: 一个简单的Spring Boot入门项目，包含启动类。 +- **SecondBootDemo**: 包含多个控制器（如AnimalController、ProductController、UserController等），用于演示RESTful API的创建和基本业务逻辑。 +- **VueDemo0827**: 前端Vue项目，展示如何通过Vue.js与后端进行交互。 +- **day0826、day0828homework、day0829**: 包含基于Spring Boot的后端业务逻辑，如客户管理、电影管理等。 +- **springboot-vue-elementPlus**: 使用Element Plus组件库的Vue前端项目，与后端进行更复杂的交互。 +- **springboot3-06-properties-location**: 展示Spring Boot中如何加载不同位置的配置文件。 + +## 主要功能模块 + +### 后端功能 + +- **RESTful API**: 提供标准的增删改查接口，如`/addAnimal`, `/animalList`, `/updateAnimalByName`, `/deleteAnimalByName`等。 +- **Swagger集成**: 在`day0826`模块中使用了Swagger来生成API文档。 +- **数据库操作**: 使用MyBatis进行数据库操作，如`CustomerMapper`、`MovieMapper`等。 +- **配置管理**: 在`springboot3-06-properties-location`模块中演示了如何从`application.properties`和`application.yml`中加载配置。 + +### 前端功能 + +- **Vue.js**: 使用Vue 3进行前端开发，实现数据绑定和组件化开发。 +- **Axios**: 用于与后端进行HTTP通信。 +- **Element Plus**: 在`springboot-vue-elementPlus`模块中使用了Element Plus组件库，实现更美观的UI交互。 + +## 技术栈 + +- **后端**: Spring Boot、MyBatis、Swagger、Maven +- **前端**: Vue.js、Axios、Element Plus +- **数据库**: 项目中未明确使用数据库，但提供了与数据库交互的接口（如Mapper类） + +## 项目亮点 + +- **前后端分离**: 后端提供RESTful API，前端通过Axios与后端通信，实现前后端分离架构。 +- **模块化设计**: 项目按照功能模块划分，便于维护和扩展。 +- **文档支持**: 使用Swagger生成API文档，便于前后端协作开发。 +- **配置管理**: 支持从不同位置加载配置文件，提高配置灵活性。 + +## 如何运行项目 + +### 后端运行步骤 + +1. 确保已安装JDK 1.8或更高版本。 +2. 使用IDE（如IntelliJ IDEA）导入项目。 +3. 运行`Spring Boot`模块的`Application`类启动项目。 +4. 访问`http://localhost:8080`查看接口文档（如果配置了Swagger）。 + +### 前端运行步骤 + +1. 确保已安装Node.js和npm。 +2. 进入`VueDemo0827`或`springboot-vue-elementPlus`目录。 +3. 执行`npm install`安装依赖。 +4. 执行`npm run serve`启动开发服务器。 +5. 访问`http://localhost:8080`查看前端页面。 + +## 项目用途 + +该项目主要用于学习Spring Boot和Vue.js的基础知识，以及如何实现前后端分离架构下的数据交互。适合初学者掌握RESTful API设计、Vue.js基础、Axios使用、Element Plus组件库集成等技能。 + +## 贡献者 + +该项目由个人开发者维护，适合用于学习和实验。欢迎提交Issue和Pull Request以改进项目。 \ No newline at end of file -- Gitee