diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..b2e0a2e --- /dev/null +++ b/docs/index.html @@ -0,0 +1,959 @@ + + + + + + Oikos — The Self-Hosted Family Planner + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Oikos

+

The self-hosted family planner

+

Manage your household together. Tasks, shopping, meals, calendar, budget — all in one place. Self-hosted, private, yours.

+ + + View on GitHub + +
+ MIT License + Docker Ready + PWA + No Cloud Required +
+
+ + +
+
+
+

Features

+

Everything your household needs

+

A complete set of tools designed for families, built to work together seamlessly.

+
+
+
+ +

Task Management

+

Shared tasks with deadlines, priorities, subtasks, recurring schedules, and a Kanban board view.

+
+
+ +

Shopping Lists

+

Collaborative lists with aisle categories and one-click import from your meal plans.

+
+
+ +

Meal Planning

+

Weekly drag-and-drop planner with ingredient lists and automatic shopping list export.

+
+
+ +

Calendar Sync

+

Two-way sync with Google Calendar (OAuth) and Apple iCloud (CalDAV). All events in one place.

+
+
+ +

Budget Tracking

+

Track income and expenses, manage recurring entries, view monthly trends, and export to CSV.

+
+
+ +

Notes

+

Colored sticky notes with Markdown support. Perfect for family memos, recipes, and quick reminders.

+
+
+ +

Contacts

+

Shared family contact directory with vCard import and export.

+
+
+ +

Works Everywhere

+

Installable as a PWA on any device. Works offline, supports dark mode, responsive from phone to desktop.

+
+
+
+
+ + +
+
+
+

Preview

+

See it in action

+

A clean, intuitive interface that adapts to your device and preferred theme.

+
+
+
+
+ Oikos Dashboard +

Dashboard

+
+
+ Task Management +

Tasks

+
+
+ Meal Planning +

Meals

+
+
+ Shopping Lists +

Shopping

+
+
+ Calendar +

Calendar

+
+
+ Budget Tracking +

Budget

+
+
+ Notes +

Notes

+
+
+ Contacts +

Contacts

+
+
+
+ + +
+
+
+

Philosophy

+

Built different, on purpose

+

No subscriptions, no vendor lock-in, no data leaving your home.

+
+
+
+ +
+

Privacy First

+

AES-256 encrypted database with SQLCipher. Zero telemetry. Your data never leaves your server.

+
+
+
+ +
+

Fully Self-Hosted

+

Runs on a Raspberry Pi, a NAS, or any server. Docker makes setup a one-liner.

+
+
+
+ +
+

Zero Build Step

+

Pure ES modules, vanilla JS, plain CSS. No bundler, no transpiler, no framework. Ships what you write.

+
+
+
+ +
+

Open Source

+

MIT licensed. Inspect, modify, extend, contribute. Built in the open for families who care about transparency.

+
+
+
+
+
+ + +
+
+
+

Get Started

+

Up and running in minutes

+
+
+
+# Clone and configure +git clone https://github.com/ulsklyc/oikos.git && cd oikos +cp .env.example .env # set SESSION_SECRET and DB_ENCRYPTION_KEY + +# Start with Docker +docker compose up -d --build +docker compose exec oikos node setup.js +
+

Then open http://localhost:3000 and log in. Need help? The Installation Guide covers everything from installing Docker to HTTPS, backups, and troubleshooting.

+
+
+
+ + + + + + + diff --git a/docs/og-image.png b/docs/og-image.png new file mode 100644 index 0000000..caa8218 Binary files /dev/null and b/docs/og-image.png differ diff --git a/docs/twitter-image.png b/docs/twitter-image.png new file mode 100644 index 0000000..0b00781 Binary files /dev/null and b/docs/twitter-image.png differ