Skip to content

A simple system for keeping track of where everything is stored.

License

Notifications You must be signed in to change notification settings

kadaliao/house-keeper

Repository files navigation

家庭物品管理系统 (House Keeper)

项目简介

家庭物品管理系统是一个用于跟踪、管理和组织家庭物品的应用程序。它允许用户记录物品的位置、类型、提醒事项等信息,帮助用户更好地管理家庭物品。

主要功能

  1. 物品管理

    • 添加新物品
    • 查看物品列表
    • 更新物品信息
    • 删除物品
    • 上传物品图片
  2. 位置管理

    • 创建位置
    • 查看位置列表
    • 更新位置信息
    • 支持位置层级结构
  3. 物品类型管理

    • 创建物品类型
    • 查看物品类型列表
    • 支持物品类型的层级关系
  4. 提醒功能

    • 为物品设置提醒
    • 查看提醒列表
  5. 搜索功能

    • 根据关键词搜索物品

技术栈

  • 后端:FastAPI
  • 数据库:SQLite (通过 SQLAlchemy ORM)
  • 测试:pytest

安装和运行

  1. 克隆仓库:

    git clone https://github.com/your-username/house-keeper.git
    cd house-keeper
    
  2. 安装依赖:

    pip install -r requirements.txt
    
  3. 运行后端服务:

    uvicorn main:app --reload
    

API 文档

启动后端服务后,访问 http://localhost:8000/docs 查看完整的 API 文档。

测试

运行测试:

pytest test_main.py

添加测试数据

要添加一些测试数据到系统中,运行:

python add_test_items.py

Roadmap

以下是我们计划在未来版本中添加的功能:

  1. 搜索增强

    • 搜索范围扩展到物品名称和标签字段
    • 在查询指定位置物品时,包含子位置的物品
  2. AI 集成

    • 使用 LLM 进行自然语言查询位置和物品
    • 通过 LLM 输入位置和物品信息
    • AI 识别图片内容,自动生成默认输入项
  3. 物品信息增强

    • 识别条形码、二维码内容
    • 自动获取书本信息、药品信息、电子产品信息
    • 支持电子产品包装盒的存放记录
    • 允许一个物品的多个部分分开存放
    • 建立物品之间的关联关系
  4. 多用户支持

    • 实现多用户、多账户、多空间功能
  5. 高级提醒功能

    • 周报盘点提醒
    • 物品过期前 N 日提醒
  6. 用户界面优化

    • 开发直观、易用的前端界面
    • 支持移动端访问
  7. 数据分析和可视化

    • 物品使用频率分析
    • 存储空间利用率报告
  8. 导入/导出功能

    • 支持数据的批量导入和导出
  9. 安全性增强

    • 实现用户认证和授权
    • 数据加密存储
  10. 集成外部服务

    • 与智能家居系统集成
    • 支持语音助手查询和操作

我们将根据用户反馈和需求优先级逐步实现这些功能。欢迎贡献想法和代码!

贡献

欢迎提交 Pull Requests 来改进这个项目。对于重大更改,请先开 issue 讨论您想要改变的内容。

许可证

MIT

About

A simple system for keeping track of where everything is stored.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages