v1.7.1:完整的数据导出、Google Gemini 与官方 Docker 镜像

家庭生活,
尽在您的掌控。

一款开源、自托管的应用,助您打理全家生活:购物、任务、日历、预算、食谱等。

体验在线演示 下载 Windows 版 在 Google Play 上获取 GitHub
12模块
PWA可安装
AGPL-3开源
自托管您的数据
截图

实际效果展示

简洁高效的界面,这里展示的是演示家庭数据。立即体验,不会保存任何内容。

仪表盘 预算 日历 购物清单 餐食计划 家庭
打开在线演示

功能

满足家庭所需的一切

12 个内置模块,在所有设备间实时同步。

购物清单

自动分类、价格、数量和可复用模板。在店内即可实时勾选已购项目。

任务管理

周期性任务、3 个优先级、可分配给家庭成员。

日历

按成员配色的月视图,支持重复与全天日程、为每个日程单独配色、搜索,以及可配置的自动提醒。

每周计划

每位成员的工作与上学时间表,按天划分时间段。

食谱

家庭食谱库,包含食材、步骤、图片、标签和高级筛选。

餐食计划

与食谱关联的周视图,可将本周计划导出为 PDF。

预算

月度支出追踪、分类限额与家庭趋势图表。

家庭成员档案

记录每位成员的健康信息、过敏史、疫苗接种和紧急联系人。

家庭动态

面向全家的共享动态:文字、照片或链接。所有人都能看到,每位成员都可标记为已读。

v1.7.0

实时同步

通过 WebSocket 将每次更改即时同步到所有设备。

v1.0.7

推送通知

通过 Web Push VAPID 发送预约提醒和任务提示,应用关闭时也能收到。

v1.0.7

共享账户

通过链接邀请成员,支持访问申请、家长/孩子角色和所有权转移。

v1.0.7

可安装的 PWA

在 iOS、Android 或桌面端像原生应用一样安装,并支持离线使用。


集成

与您的自托管生态系统连接

一键将 OpenFamily 与您的自托管应用同步,无需编辑任何配置文件。

Mealie

自动导入您的全部食谱(支持分页,API v1 与 v2)。

食谱
Tandoor

Tandoor

通过 Django REST API 导入食谱。

食谱

Home Assistant

通过 WebSocket 同步购物清单。兼容新版(2023.6+)和旧版待办实体。

购物

Grocy

与您的 Grocy 实例同步购物清单和库存。

购物与库存

Nextcloud

通过 CalDAV 导入,自动发现日历并按 UID 去重。

日历

感谢 Makernix

将 OpenFamily 与家庭自托管生态系统(Mealie、Grocy、Home Assistant、Nextcloud)连接的想法,源于与 Makernix 的一次直接交流。


安装

5 分钟即可就绪

在 Windows 上,只需双击一下即可。其他系统唯一的前提条件是 Docker。

Windows:一体化安装程序

下载 OpenFamily-Setup.exe 并按照引导操作。Node.js 和 PostgreSQL 已内置:无需 Docker,无需配置。程序会打开一个带有三个按钮(启动、停止、打开)的窗口,并显示可供手机访问的本地地址。

下载最新版本(Windows)

Android:应用程序(APK)

下载 OpenFamily.apk,允许安装未知来源的应用,然后打开应用并输入您自己服务器的地址。将该仓库添加到 Obtainium,即可从 GitHub Releases 自动获取更新。

下载 APK(Android)
1

克隆项目并配置环境

复制环境变量文件并填写您的配置(JWT 密钥、URL、VAPID 等)。

git clone https://github.com/NexaFlowFrance/OpenFamily.git
cd OpenFamily
cp .env.example .env
# Edit .env with your settings
2

使用 Docker Compose 启动

启动 3 个服务:PostgreSQL、Express 服务器和 Nginx 前端。若不想自行构建,可将 compose 文件指向官方镜像 ghcr.io/nexaflowfrance/openfamily-server-client,然后去掉 --build 运行。

docker-compose up -d --build
3

打开应用

该应用可在您的本地网络中访问(生产环境下则通过您的域名访问)。

Frontend: http://localhost:3000
API:      http://localhost:3001/health
4

验证一切正常

运行冒烟测试以验证所有 API 模块。

npm run smoke:api

云服务

不想自己托管?

自托管将始终免费。对于不想自己运行服务器的家庭,还有 OpenFamily Cloud:完全相同的应用,由我们为您托管。

OpenFamily Cloud,现已上线

无需安装,自动更新与备份,数据托管于法国。同样的开源应用,无广告、无追踪,并且您可以随时导出全部数据并切换回自托管

每个家庭 3.90 €/月。一份订阅覆盖全家,可直接在应用内开通。

在 Google Play 上获取

技术

现代技术栈,毫不妥协

每一项技术选型都兼顾性能、安全与可维护性。

React 19 TypeScript Vite 7 TailwindCSS Radix UI Node.js 20 Express PostgreSQL 16 WebSocket (ws) Web Push VAPID JWT + bcrypt 12 Helmet Docker Nginx GitHub Actions PWA / Service Worker Recharts date-fns Fraunces + Instrument Sans

开源、自托管,完全属于您。

您的数据由您掌控。现在就为项目贡献力量,或部署属于自己的实例。

体验在线演示 提交问题
团队

致谢

感谢所有为本项目做出贡献的人。

NexaFlowFrance NexaFlowFrance 125 次提交 thecybermacgyver thecybermacgyver 长期贡献者 QuentinCazier QuentinCazier 5 次提交 LoicHarrang1 LoicHarrang1 4 次提交 victorprouff victorprouff 4 次提交 filipevieira filipevieira 3 次提交 ShizengLiu ShizengLiu 2 次提交 streletskiy streletskiy 2 次提交 lakhassane lakhassane 1 次提交 caludeayi caludeayi 1 次提交 blastik blastik 1 次提交

第三方集成的创意:感谢 Makernix。这个想法源于与他的一次直接交流。

在 Ko-fi 上支持本项目

想要参与贡献? 阅读文档 →