OpenFamily
The open-source, self-hosted family organizer
Keep full control of your family's data: run it on your own server, or let us host it for you in France.
๐ฌ๐ง
English ยท ๐ซ๐ท
Franรงais ยท ๐จ๐ณ
็ฎไฝไธญๆ
[](https://github.com/NexaFlowFrance/OpenFamily/releases/latest)
[](https://github.com/NexaFlowFrance/OpenFamily/actions/workflows/ci.yml)
[](https://openfamily.fr/demo/)
[](https://github.com/NexaFlowFrance/OpenFamily/pkgs/container/openfamily)
[](licence.md)
[](https://github.com/NexaFlowFrance/OpenFamily)
---
### ๐ฌ [Try the live demo](https://openfamily.fr/demo/)
*No sign-up, runs entirely in your browser, nothing is saved.*
OpenFamily is a **self-hosted alternative to apps like Cozi or FamilyWall**: shopping lists,
tasks, a shared calendar, weekly planning, recipes, meal planning, a pantry and a household
budget, all in one place, on your own server.
## ๐ What sets it apart
| | |
|---|---|
| ๐ฑ **A real Android app** | An [APK](https://github.com/NexaFlowFrance/OpenFamily/releases/latest/download/OpenFamily.apk) that connects to your own server, kept up to date with Obtainium. On any other phone, the web app installs to the home screen. |
| ๐ **Open to the rest of the house** | A [documented API](API.md) with personal tokens and webhooks, and integrations with Home Assistant, [Gladys Assistant](https://github.com/NexaFlowFrance/gladys-openfamily), Mealie, Tandoor, Grocy and Nextcloud. Your home automation can read the family's day and add to the shopping list. |
| ๐ผ๏ธ **At home on a wall** | A kiosk mode for a tablet in the kitchen, with a screensaver, and login-free pages made for an e-paper frame or an e-reader. |
| ๐ค **An assistant that can stay at home** | Add things in plain language and get menu ideas from your own recipes, with a local model through Ollama or the provider of your choice. Optional, and off until you set it up. |
| ๐ณ **Running in one command** | [One container](#-docker-in-one-command), nothing to configure. On Windows, an installer with no Docker at all. |
| โ๏ธ **Or hosted for you** | [OpenFamily Cloud](https://openfamily.fr/#cloud) runs the same open-source app on servers in France, for families who would rather not run one. You can export everything and move to your own server whenever you want. |
## โจ Features
| | |
|---|---|
| ๐ **Shopping list** | Categories, prices, quantities, templates, **aisle-by-aisle store mode** |
| ๐ง **Pantry** | What is at home, by place (fridge, freezer, cupboard), with use-by dates and what to eat first, **barcode lookup** (typed, scanned with the camera or a handheld scanner) and one tap to the shopping list |
| โ
**Tasks** | Recurring tasks, family assignment, statistics |
| ๐
**Appointments** | Monthly calendar, automatic reminders, color coding, **birthdays** taken from the family's dates of birth, **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 |
| ๐ผ๏ธ **Wall & e-paper displays** | Full-screen kiosk for a tablet, with a screensaver (photos or a moving clock) for screens left on all day, and **display links**: a login-free page of the family's day for an e-paper frame (InkyPi), an e-reader or any screen that cannot sign in |
| ๐ **API, tokens & webhooks** | A [documented API](API.md) for Home Assistant, Gladys Assistant, n8n or a script: personal tokens, read-only or read-write and revocable at any time, real-time updates over WebSocket, and webhooks that call your tools when the family's data changes |
| ๐ค **AI assistant** *(optional)* | Say it in plain language ("lasagna on Thursday evening, and remind Mia about her swimming bag") and it lands in the right place, and get menu ideas from your recipes. Works with a local model (Ollama), any OpenAI-compatible API, Anthropic Claude or Google Gemini |
| ๐ฅ **Shared accounts** | Invite by link, **access requests**, **ownership transfer** |
| ๐ **Single sign-on** | Sign in with your own OpenID Connect provider (Authentik, Keycloak, Pocket ID...), optional SSO-only servers, **sign out of all devices** |
| ๐ก๏ธ **Roles & permissions** | **Parent / child** accounts, with a read-only budget for children |
| ๐ **Multilingual** | **English / French / German / Portuguese / Russian / Spanish / Catalan / Simplified Chinese** interface with automatic detection |
| ๐ด **Offline mode** | Browse cached data without a connection (PWA) |
## ๐ธ Screenshots
| Shopping (store mode) | Calendar | Budget |
|---|---|---|
|