Skip to content
GloridustPublic

About

干饭厨子|飞牛Nas 上可部署的家庭点菜系统

Resources

Contributing

Stars

105 stars

Watchers

1 watching

Forks

Latest commit

 

History

43 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

干饭厨子

🍳 干饭厨子 · GanCook

可一键部署到 NAS 的家庭点菜系统 —— 让一家人轮流做饭、点菜、互相打分。

Docker Next.js SQLite License Telegram

中文 · English

💬 交流 / 反馈 / 许愿 → Telegram 讨论组 @GanCookProj


「今天谁做饭?」「吃啥?」——干饭厨子把这两个每天都要吵一遍的问题,变成一件温馨小事。

前一天晚上自动开好明天的饭局,家人各自点菜,谁掌勺谁认领,吃完打个分; 月底还能在贡献墙上看看这个月是谁在默默下厨。专为家庭设计,不依赖任何云服务,数据全在你自己的 NAS 上。

✨ 特性

  • 🚀 真·开箱即用 —— 一条 docker run 跑起来,无需配置任何环境变量,密钥首启自动生成并持久化。
  • 🗄️ 单容器 + SQLite —— 没有外部数据库、没有云依赖,备份只需复制一个 data 目录。
  • 👨‍👩‍👧 一账号多角色 —— 注册不分身份,人人都能做饭、点菜;做饭人按「每一餐」认领(「我来做这顿」)。
  • 👆 选头像登录 —— 共享设备上无需打字,点自己的头像再输 6 位密码即可(像选用户头像)。
  • ⏰ 自动饭局(像设闹钟) —— 在后台自由增删多条规则:餐次、时间、提前多久开、提前多久截止、生效星期都可自定义。到点自动开局、截止自动进入做饭、用餐后自动完成。
  • 🔎 菜多也好点 —— 搜索 + 按标签分类筛选(荤菜 / 素菜 / 汤…),列表/网格随手切;早餐「包子 ×5」也能点份数。
  • 🎲 今天吃点啥 —— 选好「一荤一素一汤」,随机配一桌,最近吃过的少推荐,一键全点。
  • 📦 菜单导入导出 —— 整个菜单连图片打包成 zip 分享给亲友;也能直接导入一包照片(文件名就是菜名)或一份 txt 菜名清单。
  • 🔗 菜谱链接导入 —— 粘贴下厨房 / 小红书分享,自动预填菜名、做法和封面(可选接入 LLM 整理)。
  • 🌱 贡献墙 —— GitHub 风格热力图,谁做饭最勤、谁最会点菜,绿格子一目了然。
  • 🖼️ 图片不拖后腿 —— 头像/菜品上传自动裁剪压缩(≤2MB)转 WebP 落盘(告别 base64 进库),加载飞快。
  • 🥛 牛奶布艺 UI —— 柔和拟物 + 青菜绿,移动端优先,可作为 PWA 添加到主屏。
  • 🌍 中英双语 —— 登录页与「我的 · 设置」一键切换。
  • 🔄 升级无痛 —— 拉新镜像即可,数据库自动迁移,登录态不丢;管理员还能在网页端一键更新(需挂载 Docker 套接字,否则降级为手动指引)。

📸 预览

选头像登录
👆 选头像登录
共享设备免打字,点头像 + 6 位密码
临近的饭局
🏠 临近的饭局
谁掌勺、等不等你点菜,一眼看清
点菜 + 认领做饭
🍽️ 点菜 · 认领做饭
搜索 / 分类筛选,还能点份数
今天吃点啥
🎲 今天吃点啥
一荤一素一汤,随机配一桌
菜品库
📖 菜品库
标签分类,菜再多也好找
谁点了什么 + 餐后打分
⭐ 大家点了什么 · 打分
掌勺的要做清单,吃完互相评价
历史饭局
🗓️ 历史饭局
吃过什么、谁做的、几分
贡献墙
🌱 贡献墙
谁在为这个家默默下厨,绿格子见证
自动饭局规则
⏰ 自动饭局(像设闹钟)
到点自动开局、截止、流转

一条线把这些串起来:前一晚自动开好明天的饭局 → 家人各自点菜 → 谁做饭点一下「我来做这顿」 → 吃完打个分 → 月底贡献墙上看看谁最辛苦。

🚀 快速开始

镜像地址(任选其一):

  • 🐳 Docker Hub(国内飞牛等 NAS 有加速,推荐):gloridust/gancook:latest
  • 📦 GHCR(海外):ghcr.io/gloridust/gancook:latest

:latest 始终是最新正式版(也可固定版本如 :0.2.1、:0.2);:main 是跟随主分支的开发版,仅供尝鲜。

方式一:docker run(最简单)

docker run -d --name gancook \
  -p 3000:3000 \
  -v ./data:/data \
  --restart unless-stopped \
  gloridust/gancook:latest

打开 http://<你的NAS地址>:3000,第一个注册的人即成为管理员。完事。

方式二:docker compose(推荐,便于升级)

curl -O https://raw.githubusercontent.com/Gloridust/GanCook/main/docker-compose.yml
docker compose up -d

飞牛 / 群晖等 NAS 也可以直接在「Docker / Container Manager」里搜索镜像 gloridust/gancook 创建容器: 端口映射 3000,把容器内 /data 映射到一个你方便备份的目录即可。

无需设置任何环境变量。如需自定义,可选:

变量 默认 说明
TZ Asia/Shanghai 时区,影响自动饭局时间
AUTH_SECRET 自动生成 会话签名密钥(留空自动生成并存到 data/auth.secret)
CRON_SECRET 自动生成 定时触发端点密钥
COOKIE_SECURE 自动 会话 Cookie 是否强制 Secure;默认按请求协议判断,HTTPS 反代识别异常时可设为 1

反向代理 / 外网访问

直接用 IP:端口、飞牛 / 群晖的远程访问(含手机 App 内打开)都能直接用,无需额外配置。 自己用 nginx 等反代时,建议透传这几个请求头(Caddy、NPM、飞牛/群晖自带反代默认已透传):

location / {
    proxy_pass http://127.0.0.1:3000;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-Host $host;
    proxy_set_header X-Forwarded-Proto $scheme;
    client_max_body_size 64m;   # 导入菜单压缩包
}

暴露到公网时:登录已内置防爆破(连续输错 5 次后冷却),仍建议在「家庭管理」里设置注册口令或关闭注册。

📖 入门指南(5 分钟上手)

  1. 部署并打开 —— 用上面任一方式启动,浏览器访问 http://<NAS>:3000。
  2. 建立家庭 —— 首次进入是引导页:填家庭名 + 你的昵称 + 6 位密码,你成为管理员。
  3. 家人加入 —— 家人各自打开同一地址 →「注册」,填昵称 + 6 位密码即可。之后登录只需在列表里点自己的头像再输密码。 (管理员可在「我的 → 家庭管理」里设置注册口令或关闭注册。)
  4. 添加菜品 —— 进「菜品」把全家拿手菜加进来(可拍照,自动压缩),点一下快捷标签就能分好类。 菜多?右上角「⋯ → 导入菜单」:一包照片(荤菜/红烧肉.jpg → 菜名「红烧肉」、标签「荤菜」)或一份 txt(每行「菜名 标签」)即可批量建好。
  5. 开一顿饭局 —— 首页或「饭局」点「开饭局」,选餐次/时间/截止;家人进去搜索/按分类点菜(可加份数), 拿不定主意就点「随便来点」;谁做饭点「我来做」,掌勺的人看「大家点了什么」就是今天的要做清单。
  6. 设置自动饭局 —— 「我的 → 家庭管理 → 自动饭局」像设闹钟一样添加规则: 例如「每日午餐 12:00、前一天 20:00 自动开、提前 2 小时截止」。以后每天自动开局、自动流转。
  7. 看贡献墙 —— 「贡献」页用绿格子记录每个人做饭/点菜的活跃度。
  8. 切换语言 —— 登录页或「我的 → 语言」可在中文 / English 间切换。

想换语言或备份?语言在「我的」里随时切;备份只要复制 data 目录。

🔄 升级到新版本

docker compose pull && docker compose up -d
# docker run 方式:docker pull gloridust/gancook:latest 后重新创建容器

数据与密钥都在 data 卷里,升级时数据库会自动迁移,登录态保持不变。 想全自动更新可搭配 Watchtower。

网页端一键更新(可选):在「家庭管理 → 关于与更新」可查看版本、点按钮自动拉新镜像并重建容器。 需要让容器能访问 Docker:在 docker-compose.yml 里挂载 /var/run/docker.sock 并以可访问该套接字的用户运行(见 compose 注释)。 未挂载或权限不足时会自动降级为显示手动更新命令,不影响使用。

💾 备份

整个应用的状态只在一个地方:你映射出来的 data 目录(包含 app.db 与 uploads/)。 定时复制这个目录即是完整备份;恢复时放回去再启动即可。

🛠️ 本地开发

git clone https://github.com/Gloridust/GanCook.git
cd GanCook
npm install
cp .env.example .env.local   # 本地可按需修改
npm run db:migrate           # 初始化 SQLite
npm run dev                  # http://localhost:3000

🧱 技术栈

  • Next.js 16(App Router · Server Actions)+ React 19 + TypeScript
  • SQLite + Drizzle ORM(better-sqlite3)
  • 鉴权:bcrypt + jose 签名 JWT + httpOnly Cookie
  • 图片:sharp 压缩转 WebP 落盘
  • 调度:进程内 node-cron(启动钩子 instrumentation.ts 拉起)
  • 样式:TailwindCSS v4 + 自建「牛奶布艺」设计系统 + Framer Motion

🗺️ 路线图

  • 中英双语
  • 菜品标签筛选与搜索、点菜份数
  • 随便来点(按分类随机配菜)
  • 菜单导入导出(zip / 图片包 / txt)
  • 菜谱链接导入(下厨房 / 小红书,可选 LLM 整理)
  • 消息提醒(开局 / 截止前推送到企业微信、Bark 等)
  • 多人协作做饭 / 买菜清单
  • 开放 API

欢迎在 Issues 里许愿 🙌

🤝 贡献

欢迎 Issue / PR!开发约定见 CONTRIBUTING.md。

📄 License

MIT · Made with ❤️ for family dinners

About

干饭厨子|飞牛Nas 上可部署的家庭点菜系统

Resources

Contributing

Stars

105 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages