一款开源、自托管的应用,助您打理全家生活:购物、任务、日历、预算、食谱等。
简洁高效的界面,这里展示的是演示家庭数据。立即体验,不会保存任何内容。
12 个内置模块,在所有设备间实时同步。
自动分类、价格、数量和可复用模板。在店内即可实时勾选已购项目。
周期性任务、3 个优先级、可分配给家庭成员。
按成员配色的月视图,支持重复与全天日程、为每个日程单独配色、搜索,以及可配置的自动提醒。
每位成员的工作与上学时间表,按天划分时间段。
家庭食谱库,包含食材、步骤、图片、标签和高级筛选。
与食谱关联的周视图,可将本周计划导出为 PDF。
月度支出追踪、分类限额与家庭趋势图表。
记录每位成员的健康信息、过敏史、疫苗接种和紧急联系人。
面向全家的共享动态:文字、照片或链接。所有人都能看到,每位成员都可标记为已读。
v1.7.0通过 WebSocket 将每次更改即时同步到所有设备。
v1.0.7通过 Web Push VAPID 发送预约提醒和任务提示,应用关闭时也能收到。
v1.0.7通过链接邀请成员,支持访问申请、家长/孩子角色和所有权转移。
v1.0.7在 iOS、Android 或桌面端像原生应用一样安装,并支持离线使用。
一键将 OpenFamily 与您的自托管应用同步,无需编辑任何配置文件。
自动导入您的全部食谱(支持分页,API v1 与 v2)。
食谱
通过 Django REST API 导入食谱。
食谱通过 WebSocket 同步购物清单。兼容新版(2023.6+)和旧版待办实体。
购物与您的 Grocy 实例同步购物清单和库存。
购物与库存通过 CalDAV 导入,自动发现日历并按 UID 去重。
日历将 OpenFamily 与家庭自托管生态系统(Mealie、Grocy、Home Assistant、Nextcloud)连接的想法,源于与 Makernix 的一次直接交流。
在 Windows 上,只需双击一下即可。其他系统唯一的前提条件是 Docker。
下载 OpenFamily-Setup.exe 并按照引导操作。Node.js 和 PostgreSQL 已内置:无需 Docker,无需配置。程序会打开一个带有三个按钮(启动、停止、打开)的窗口,并显示可供手机访问的本地地址。
下载最新版本(Windows)下载 OpenFamily.apk,允许安装未知来源的应用,然后打开应用并输入您自己服务器的地址。将该仓库添加到 Obtainium,即可从 GitHub Releases 自动获取更新。
下载 APK(Android)复制环境变量文件并填写您的配置(JWT 密钥、URL、VAPID 等)。
git clone https://github.com/NexaFlowFrance/OpenFamily.git cd OpenFamily cp .env.example .env # Edit .env with your settings
启动 3 个服务:PostgreSQL、Express 服务器和 Nginx 前端。若不想自行构建,可将 compose 文件指向官方镜像 ghcr.io/nexaflowfrance/openfamily-server 和 -client,然后去掉 --build 运行。
docker-compose up -d --build
该应用可在您的本地网络中访问(生产环境下则通过您的域名访问)。
Frontend: http://localhost:3000 API: http://localhost:3001/health
运行冒烟测试以验证所有 API 模块。
npm run smoke:api
自托管将始终免费。对于不想自己运行服务器的家庭,还有 OpenFamily Cloud:完全相同的应用,由我们为您托管。
每一项技术选型都兼顾性能、安全与可维护性。
感谢所有为本项目做出贡献的人。
NexaFlowFrance
125 次提交
thecybermacgyver
长期贡献者
QuentinCazier
5 次提交
LoicHarrang1
4 次提交
victorprouff
4 次提交
filipevieira
3 次提交
ShizengLiu
2 次提交
streletskiy
2 次提交
lakhassane
1 次提交
caludeayi
1 次提交
blastik
1 次提交
第三方集成的创意:感谢 Makernix。这个想法源于与他的一次直接交流。
想要参与贡献? 阅读文档 →