Skip to content

NexaFlowFrance/OpenFamily

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

105 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

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
🌍 Bilingual English / French 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.

🀝 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

License

Security policy

Stars

124 stars

Watchers

3 watching

Forks

Packages

 
 
 

Contributors