ourshoppinglist/our-shopping-list

Our Shopping List (OSL)

概述

OSL是一个简单的共享清单应用，主要用于创建和管理购物清单，以及其他需要协作使用的小型待办事项列表。它支持多用户实时同步，让团队或家庭成员能够共同编辑和更新清单内容。

!https://raw.githubusercontent.com/nanawel/our-shopping-list/master/doc/osl-usage.gif

核心功能

主要特性

• 多面板支持：可创建多个独立面板（通过环境变量VUE_APP_SINGLEBOARD_MODE可禁用，启用单一面板模式）
• 多列表管理：每个面板可包含多个子列表，实现分类管理
• 实时同步：多用户编辑时自动实时同步内容
• 项目详情：支持为列表项添加名称、数量和详情字段
• 可勾选项目：支持勾选/取消勾选项目，直观标记完成状态
• 灵活显示模式：提供两种项目显示模式（仅显示未勾选/仅显示已勾选，按勾选时间排序）
• 快速搜索：内置直观的搜索功能，便于快速定位项目
• 移动优先UI：适配移动端界面，支持项目滑动操作
• PWA基础支持：支持渐进式Web应用特性，可安装到设备主屏幕
• 国际化（i18n）：支持多语言切换（https://github.com/nanawel/our-shopping-list/blob/master/client/src/locales%EF%BC%89%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87https://hosted.weblate.org/projects/our-shopping-list/client-src-locales/%E5%8F%82%E4%B8%8E%E7%BF%BB%E8%AF%91

当前限制

• 暂不支持完整PWA功能（如离线模式和延迟同步）

使用场景

• 家庭购物计划：家庭成员共同编辑购物清单，实时更新所需物品
• 团队小型任务协作：小组内共享待办事项，同步进度
• 共享待办事项列表：如旅行准备清单、聚会物品准备清单等需要多人协作的场景

配置说明

环境变量

部署示例

Docker Run 命令

bash
docker run -d \
  --name our-shopping-list \
  -p 8080:80 \
  -e VUE_APP_SINGLEBOARD_MODE=false \
  docker.xuanyuan.run/nanawel/our-shopping-list

Docker Compose 配置

yaml
version: '3'
services:
  our-shopping-list:
    image: docker.xuanyuan.run/nanawel/our-shopping-list
    container_name: our-shopping-list
    ports:
      - "8080:80"
    environment:
      - VUE_APP_SINGLEBOARD_MODE=false  # 设置为true可禁用多面板模式
    restart: unless-stopped

注意事项

• 完整的最新文档请参考GitHub仓库：https://github.com/nanawel/our-shopping-list
• 如需扩展语言支持，可通过Weblate平台参与翻译贡献