# Keep

**Repository Path**: ningmeng2000/keep

## Basic Information

- **Project Name**: Keep
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-24
- **Last Updated**: 2025-10-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Keep 记账应用

基于 Spring Boot 开发的个人记账应用，类似鲨鱼记账。

## 技术栈

- **后端框架**: Spring Boot 2.6.13
- **数据库**: MySQL 8.0
- **ORM框架**: MyBatis-Plus 3.5.1 + Spring Data JPA
- **连接池**: Druid 1.2.8
- **工具类**: Lombok、Hutool、Apache Commons Lang3
- **数据格式**: FastJSON
- **Excel导出**: Apache POI

## 功能特性

### 核心功能
- ✅ 用户注册登录
- ✅ 快速记账（支出/收入）
- ✅ 账单分类管理
- ✅ 预算管理
- ✅ 定时记账
- ✅ 记账提醒
- ✅ 数据统计分析
- ✅ 数据导出（Excel）

### 数据库设计
- **user**: 用户表
- **category**: 账单分类表
- **bill**: 账单表
- **budget**: 预算表
- **recurring_bill**: 定时记账表
- **reminder**: 提醒表

## 快速开始

### 1. 环境要求
- JDK 1.8+
- Maven 3.x
- MySQL 8.0+

### 2. 数据库初始化

```bash
# 登录 MySQL
mysql -u root -p

# 执行初始化脚本
source src/main/resources/db/init.sql
```

或者直接创建数据库（应用启动时会自动创建表结构）：
```sql
CREATE DATABASE keep_accounting CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
```

### 3. 配置文件

修改 `src/main/resources/application.properties` 中的数据库配置：

```properties
spring.datasource.url=jdbc:mysql://localhost:3306/keep_accounting?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root
```

### 4. 启动项目

```bash
# 使用 Maven 启动
mvn spring-boot:run

# 或者打包后运行
mvn clean package
java -jar target/Keep-0.0.1-SNAPSHOT.jar
```

### 5. 访问应用

应用启动后，访问：http://localhost:8080

## 项目结构

```
Keep/
├── src/main/java/com/keep/
│   ├── KeepApplication.java          # 主启动类
│   ├── config/                        # 配置类
│   │   ├── MyBatisPlusConfig.java    # MyBatis-Plus配置
│   │   └── WebConfig.java            # Web配置（跨域等）
│   ├── common/                        # 公共类
│   │   └── Result.java               # 统一响应结果
│   ├── entity/                        # 实体类（待创建）
│   ├── mapper/                        # Mapper接口（待创建）
│   ├── service/                       # 服务层（待创建）
│   ├── controller/                    # 控制器（待创建）
│   └── demos/web/                     # 示例代码
├── src/main/resources/
│   ├── application.properties         # 应用配置
│   ├── db/init.sql                   # 数据库初始化脚本
│   └── static/                        # 静态资源
└── pom.xml                            # Maven配置

```

## 开发计划

- [x] 项目初始化和配置
- [ ] 实体类设计
- [ ] Mapper层开发
- [ ] Service层开发
- [ ] Controller层开发
- [ ] 用户认证和授权
- [ ] 数据统计和分析
- [ ] Excel导出功能
- [ ] 前端界面开发

## API 文档

待开发完成后补充...

## 作者

Keep Team

## 许可证

Apache License 2.0