# BSBookKeeper

**Repository Path**: YyModel/bsbook-keeper

## Basic Information

- **Project Name**: BSBookKeeper
- **Description**: BSBookKeeper 是一个功能完善的个人记账管理系统，提供便捷的收支记录、分类管理、数据分析和图片存储功能，帮助用户轻松管理个人财务状况。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-25
- **Last Updated**: 2025-09-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BSBookKeeper - 个人记账系统

## 项目简介
BSBookKeeper 是一个功能完善的个人记账管理系统，提供便捷的收支记录、分类管理、数据分析和图片存储功能，帮助用户轻松管理个人财务状况。

## 功能特性

### 核心功能
- **记账管理**：记录收入支出、编辑、删除记账记录
- **分类管理**：创建、编辑、删除自定义收支分类
- **图片上传**：为记账记录添加图片附件，支持查看和管理
- **数据筛选**：按关键词搜索记账记录
- **用户认证**：基于用户ID的权限验证机制

### 技术特点
- **前后端分离**：Django后端提供API，前端使用Layui框架构建用户界面
- **响应式设计**：适配不同屏幕尺寸
- **数据持久化**：使用Django ORM进行数据存储和管理
- **文件上传**：支持图片上传并存储到服务器
- **Mock数据**：API不可用时提供模拟数据，确保用户体验

## 技术栈

### 后端
- **Python** 3.12
- **Django** - Web框架
- **Django REST framework** - API构建

### 前端
- **HTML/CSS/JavaScript**
- **Layui** - UI框架
- **Axios** - HTTP请求客户端

### 数据库
- **SQLite** (默认配置)

## 项目结构

```
├── BSBookKeeper/           # 项目主配置目录
├── BloodSpiderAPI/         # API应用
│   ├── apis/               # 各模块API实现
│   │   ├── account/        # 记账模块
│   │   ├── category/       # 分类模块
│   │   ├── image/          # 图片模块
│   │   └── user/           # 用户模块
│   ├── models.py           # 数据模型
│   └── middlewares/        # 中间件
├── BloodSpiderWeb/         # Web应用
│   ├── templates/          # 前端模板
│   │   ├── 页面/           # 功能页面
│   │   └── 组件/           # 可复用组件
│   └── static/             # 静态资源
├── media/                  # 媒体文件存储
├── API_DOCS.md             # API文档
├── manage.py               # Django管理脚本
└── requirements.txt        # 项目依赖
```

## 快速开始

### 环境要求
- Python 3.12
- pip

### 安装步骤

1. **克隆项目**
   ```bash
   git clone https://gitee.com/YyModel/bsbook-keeper
   cd BSBookKeeper
   ```

2. **创建虚拟环境**
   ```bash
   python -m venv .venv
   ```

3. **激活虚拟环境**
   - Windows
     ```bash
     .venv\Scripts\activate
     ```
   - macOS/Linux
     ```bash
     source .venv/bin/activate
     ```

4. **安装依赖**
   ```bash
   pip install -r requirements.txt
   ```

5. **数据库迁移**
   ```bash
   python manage.py migrate
   ```

6. **创建超级用户**（可选）
   ```bash
   python manage.py createsuperuser
   ```

### 运行项目

```bash
python manage.py runserver
```

访问 http://127.0.0.1:8000/ 查看应用

## API文档
详细的API接口说明请参考项目根目录下的 [API_DOCS.md](API_DOCS.md) 文件。

### 主要API模块
- **分类API**：创建、列表、详情、更新、删除分类
- **记账API**：创建、列表、更新、删除记账记录
- **图片API**：上传、列表、详情、更新、删除图片

## 开发指南

### 项目配置
主要配置文件位于 `BSBookKeeper/settings.py`

### 静态文件管理
前端静态资源放置在 `BloodSpiderWeb/static/` 目录下

### 模板系统
HTML模板文件放置在 `BloodSpiderWeb/templates/` 目录下

### 媒体文件
上传的图片文件存储在 `media/account_images/` 目录下

## 许可证
本项目采用 MIT 许可证 - 详情请查看 [LICENSE](LICENSE) 文件

## 注意事项
- 确保在生产环境中修改 `settings.py` 中的 `SECRET_KEY` 和数据库配置
- 定期备份数据库和媒体文件
- 遵循用户权限验证机制，确保数据安全

---

**版本**: 1.0.0
**更新日期**: 2025-09-25