Ulas Kalayci
e5669fec24
- SPEC.md: add Recipes + Recipe Ingredients tables, recipe_id FK on Meals, External Calendars table, calendar_ref_id FK on Calendar Events, Recipes module section, recipe integration in Meals module, external calendar name/color badge and location display in Calendar module - BACKLOG.md: add completed entries for ICS subscriptions, web/CLI installer, bootstrap setup endpoint, Recipes module, external calendar names/colors, event location, and Tasks/Dashboard improvements - README.md: add Recipes to module list and Highlights section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
127 lines
6.5 KiB
Markdown
127 lines
6.5 KiB
Markdown
<div align="center">
|
|
<img src="docs/logo.svg" alt="Oikos" width="120" />
|
|
<h1>Oikos</h1>
|
|
<p><strong>Self-hosted family planner for small households</strong></p>
|
|
<p>Tasks · Shopping Lists · Meal Planning · Recipes · Calendar Sync · Budget · Notes · Contacts</p>
|
|
|
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="MIT License"></a>
|
|
<a href="https://github.com/ulsklyc/oikos/releases"><img src="https://img.shields.io/github/v/release/ulsklyc/oikos?style=flat-square&color=007AFF&label=release" alt="Latest Release"></a>
|
|
<a href="https://github.com/ulsklyc/oikos/pkgs/container/oikos"><img src="https://img.shields.io/badge/ghcr.io-oikos-2496ED?style=flat-square&logo=docker&logoColor=white" alt="Docker Image"></a>
|
|
<a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%E2%89%A522-339933?style=flat-square&logo=node.js&logoColor=white" alt="Node.js"></a>
|
|
<a href="https://github.com/ulsklyc/oikos/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat-square" alt="PRs Welcome"></a>
|
|
</div>
|
|
|
|
<br>
|
|
|
|
<table>
|
|
<tr>
|
|
<td align="center" width="33%">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/mobile-dark/mobile-dark-dashboard-2.png">
|
|
<source media="(prefers-color-scheme: light)" srcset="docs/screenshots/mobile-light/mobile-light-dashboard-2.png">
|
|
<img src="docs/screenshots/mobile-light/mobile-light-dashboard-2.png" alt="Dashboard" width="240">
|
|
</picture>
|
|
</td>
|
|
<td align="center" width="33%">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/mobile-dark/mobile-dark-tasks-2.png">
|
|
<source media="(prefers-color-scheme: light)" srcset="docs/screenshots/mobile-light/mobile-light-tasks-2.png">
|
|
<img src="docs/screenshots/mobile-light/mobile-light-tasks-2.png" alt="Tasks" width="240">
|
|
</picture>
|
|
</td>
|
|
<td align="center" width="33%">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/mobile-dark/mobile-dark-meal.png">
|
|
<source media="(prefers-color-scheme: light)" srcset="docs/screenshots/mobile-light/mobile-light-meal.png">
|
|
<img src="docs/screenshots/mobile-light/mobile-light-meal.png" alt="Meals" width="240">
|
|
</picture>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p align="center"><sub>Toggle GitHub light/dark mode to see both themes.</sub></p>
|
|
|
|
## Highlights
|
|
|
|
**Task Management:** Shared tasks with deadlines, priorities, subtasks, recurring schedules, Kanban view with one-tap status buttons for touch devices
|
|
|
|
**Shopping Lists:** Collaborative lists with aisle categories and one-click import from meal plans
|
|
|
|
**Meal Planning:** Weekly drag-and-drop planner with ingredient lists and shopping export
|
|
|
|
**Recipes:** Create, edit, duplicate, and delete reusable recipes with notes, a recipe link, and per-ingredient categories. Pre-fill meal slots from a recipe and scale ingredient quantities; save any meal as a recipe with one click.
|
|
|
|
**Calendar Sync:** Two-way sync with Google Calendar (OAuth) and Apple iCloud (CalDAV); subscribe to any public ICS/webcal URL with per-subscription color, private/shared visibility, and automatic sync
|
|
|
|
**Budget Tracking:** Income and expenses, recurring entries, configurable currency (15 currencies), monthly trends, CSV export
|
|
|
|
**Notes & Contacts:** Colored sticky notes with Markdown, contact directory with vCard import/export
|
|
|
|
**Zero Build Step:** Pure ES modules, no bundler, no transpiler, no framework. Ships what you write.
|
|
|
|
**Privacy First:** SQLCipher AES-256 encrypted database, fully self-hosted, zero telemetry
|
|
|
|
**Liquid Glass UI:** Translucent surfaces with backdrop blur, module-tinted glass overlays, spring animations - inspired by Apple's Liquid Glass, built in pure CSS
|
|
|
|
**PWA Native Feel:** Installable on any device, works offline, dark mode, responsive from phone to desktop
|
|
|
|
**Multilingual:** German, English, Spanish, French, Italian, Swedish, Greek, Russian, Turkish, Chinese, Japanese, Arabic, Hindi, and Portuguese UI with automatic locale detection
|
|
|
|
## Quick Start
|
|
|
|
**Option A — Web Installer (recommended):**
|
|
|
|
```bash
|
|
git clone https://github.com/ulsklyc/oikos.git && cd oikos
|
|
node tools/installer/install-server.js
|
|
```
|
|
|
|
Then open **http://localhost:8090** in your browser. The wizard configures your `.env`, starts Docker, and creates your admin account — no manual steps needed. Requires Node.js 18+ on the host.
|
|
|
|
**Option B — pre-built image (no clone required):**
|
|
|
|
```bash
|
|
curl -O https://raw.githubusercontent.com/ulsklyc/oikos/main/docker-compose.yml
|
|
curl -O https://raw.githubusercontent.com/ulsklyc/oikos/main/.env.example
|
|
cp .env.example .env # edit .env — set SESSION_SECRET and DB_ENCRYPTION_KEY
|
|
docker compose up -d
|
|
docker compose exec oikos node setup.js
|
|
```
|
|
|
|
**Option C — build from source:**
|
|
|
|
```bash
|
|
git clone https://github.com/ulsklyc/oikos.git && cd oikos
|
|
cp .env.example .env # edit .env — set SESSION_SECRET and DB_ENCRYPTION_KEY
|
|
docker compose up -d --build
|
|
docker compose exec oikos node setup.js
|
|
```
|
|
|
|
Then open `http://localhost:3000` and log in with the admin credentials you set in the previous step. Add family members from Settings.
|
|
|
|
> **New to Docker?** The **[Installation Guide](docs/installation.md)** walks you through every step: From installing Docker to HTTPS setup, backups, and troubleshooting.
|
|
|
|
## Tech Stack
|
|
|
|
<p>
|
|
<img src="https://img.shields.io/badge/Express-000000?style=flat-square&logo=express&logoColor=white" alt="Express">
|
|
<img src="https://img.shields.io/badge/SQLite%20%2F%20SQLCipher-003B57?style=flat-square&logo=sqlite&logoColor=white" alt="SQLite">
|
|
<img src="https://img.shields.io/badge/Vanilla_JS_(ES_Modules)-F7DF1E?style=flat-square&logo=javascript&logoColor=black" alt="Vanilla JS">
|
|
<img src="https://img.shields.io/badge/Plain_CSS-1572B6?style=flat-square&logo=css3&logoColor=white" alt="CSS">
|
|
<img src="https://img.shields.io/badge/Docker-2496ED?style=flat-square&logo=docker&logoColor=white" alt="Docker">
|
|
<img src="https://img.shields.io/badge/PWA-5A0FC8?style=flat-square&logo=pwa&logoColor=white" alt="PWA">
|
|
</p>
|
|
|
|
## Documentation
|
|
|
|
| [Installation](docs/installation.md) | [Spec & Data Model](docs/SPEC.md) | [Contributing](CONTRIBUTING.md) | [Security](SECURITY.md) | [Changelog](CHANGELOG.md) | [Backlog](BACKLOG.md) |
|
|
|---|---|---|---|---|---|
|
|
|
|
## License
|
|
|
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="MIT License"></a>
|
|
|
|
<div align="center">
|
|
<sub>Built with care for families who value privacy and simplicity.</sub>
|
|
</div>
|