Skip to content

Latest commit

ย 

History

126 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

OpenFamily

OpenFamily

The open-source, self-hosted family organizer
Keep full control of your family's data โ€” run it on your own server.

๐Ÿ‡ฌ๐Ÿ‡ง English ยท ๐Ÿ‡ซ๐Ÿ‡ท Franรงais ยท ๐Ÿ‡จ๐Ÿ‡ณ ็ฎ€ไฝ“ไธญๆ–‡

Release CI Live demo Docker License: AGPL v3 PWA


No sign-up, runs entirely in your browser, nothing is saved.

OpenFamily dashboard

OpenFamily is a self-hosted alternative to apps like Cozi or FamilyWall: shopping lists, tasks, a shared calendar, weekly planning, recipes, meal planning and a household budget โ€” all in one place, on your server, with your data.

โœจ Features

๐Ÿ›’ Shopping list Categories, prices, quantities, templates, aisle-by-aisle store mode
โœ… Tasks Recurring tasks, family assignment, statistics
๐Ÿ“… Appointments Monthly calendar, automatic reminders, color coding, iCal export (.ics / webcal)
๐Ÿ—“๏ธ Weekly planning Work hours and school timetables per family member
๐Ÿณ Recipes Family library, advanced filters, prep/cook times
๐Ÿฝ๏ธ Meal planner Weekly view, PDF export, linked recipes
๐Ÿ’ฐ Budget Monthly tracking, charts, per-category limits with alerts, recurring debits
๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Family Member profiles, health info, emergency contacts
๐Ÿ”„ Real-time sync Instant updates across every device (WebSocket)
๐Ÿ”” Notifications Appointment reminders, task alerts (Web Push VAPID) + in-app
๐Ÿ‘ฅ Shared accounts Invite by link, access requests, ownership transfer
๐Ÿ›ก๏ธ Roles & permissions Parent / child accounts โ€” read-only budget for children
๐ŸŒ Multilingual English / French / Simplified Chinese interface with automatic detection
๐Ÿ“ด Offline mode Browse cached data without a connection (PWA)

๐Ÿ“ธ Screenshots

Shopping (store mode) Calendar Budget
Shopping list Calendar Budget
Meal planner Family Weekly planning
Meal planner Family Weekly planning

๐Ÿ”— Third-party integrations

Connect OpenFamily to your self-hosted ecosystem in one click โ€” no config files to edit.

App Type What is synced
Mealie ๐Ÿฒ Recipes Automatic import of all recipes (pagination, API v1 & v2)
Tandoor ๐ŸŒฟ Recipes Import via the Django REST API
Home Assistant ๐Ÿ  Shopping Shopping-list sync over WebSocket (modern todo entities + legacy)
Grocy ๐Ÿฅฆ Shopping & stock Shopping list and stock synchronization
Nextcloud โ˜๏ธ Calendar CalDAV import with auto-discovery and per-UID deduplication

๐ŸŽฌ Thanks to Makernix โ€” the idea of connecting OpenFamily to the self-hosted family ecosystem (Mealie, Grocy, Home Assistant, Nextcloud) emerged from a direct exchange with him.

๐Ÿš€ Quick start

๐ŸชŸ Windows installer (.exe) โ€” the easiest path

For Windows users, NexaFlow provides an all-in-one graphical installer: Node.js and PostgreSQL are bundled โ€” no Docker, no configuration required.

Download OpenFamily for Windows

Run OpenFamily-Setup.exe, click Start, and the app opens at http://localhost:3000. The window also shows your local network address so you can open it from a phone on the same Wi-Fi, and the Settings tab explains how to set up Tailscale for secure remote access.

๐Ÿ“ฑ Android app (APK)

OpenFamily also has a native Android app โ€” a thin client that connects to your own server (you enter its address on first launch, just like the Nextcloud or Home Assistant apps). It hosts nothing itself.

Download OpenFamily for Android

Install the APK, allow installs from unknown sources when prompted, open the app and enter your server URL (e.g. http://192.168.1.10:3001, or your HTTPS / Tailscale address).

๐Ÿ”„ Stay up to date automatically: add the repo to Obtainium to receive app updates straight from GitHub Releases โ€” no app store required.

๐Ÿณ Docker (recommended for a server)

cp .env.example .env   # edit your settings
docker-compose up -d --build

Verify the stack end-to-end:

npm run smoke:api

๐Ÿ› ๏ธ Manual install

npm run install:all
psql -U postgres -c "CREATE DATABASE openfamily;"
psql -U postgres -d openfamily -f server/schema.sql
cp .env.example .env
npm run dev

๐Ÿ†š Why OpenFamily?

OpenFamily Cozi / FamilyWall
Your data on your server โœ… โŒ
Open source (AGPL-3.0) โœ… โŒ
No ads, no tracking โœ… โŒ
Self-hosted integrations (Mealie, Grocy, Home Assistantโ€ฆ) โœ… โŒ
Works offline (PWA) โœ… โš ๏ธ

๐Ÿงฐ Tech stack

Frontend โ€” React 19 ยท TypeScript ยท Vite 7 ยท TailwindCSS ยท Radix UI ยท i18next ยท PWA (service worker, web push, offline) Backend โ€” Node.js 20 ยท Express ยท PostgreSQL 16 (auto-migration) ยท WebSocket ยท Web Push (VAPID) ยท JWT + bcrypt 12 ยท helmet ยท rate limiting DevOps โ€” Docker Compose (postgres, server, client/nginx) ยท GitHub Actions (CI + Docker publish to ghcr.io + GitHub Pages demo)

๐Ÿ” Security

JWT auth (7 days, auto refresh) ยท passwords hashed with bcrypt (cost 12) ยท secure HTTP headers via helmet ยท rate limiting on auth endpoints ยท strict configurable CORS ยท server-side input validation ยท structured logs (no sensitive data).

๐Ÿ—บ๏ธ Roadmap

Planned features and design decisions live in ROADMAP.md.

๐Ÿ’› Support the project

OpenFamily is free, open source (AGPL-3.0) and self-hosted โ€” no ads, no tracking, no paid tier. It is built and maintained on personal time. If it helps your family, you can support its development:

Sponsor OpenFamily on GitHub Support OpenFamily on Ko-fi

Starring the repository helps just as much โ€” it is how other families find the project.

๐Ÿค Contributing

Contributions are welcome! Open an issue or a pull request.

๐Ÿ“„ License

GNU Affero General Public License v3.0 (AGPL-3.0-only) โ€” see licence.md.

๐Ÿ™ Credits

Built and maintained by NexaFlow France. This project embraces the open-source philosophy and encourages sharing and community contribution.

About

The open-source, self-hosted family organizer. Keep full control of your family's data : run it on your own server.

Topics

Resources

Security policy

Stars

145 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages