Matrix Family

Privacy-first communication ecosystem built on the Matrix protocol.

Website: matrix.family

Repository Structure

This repository is a monorepo containing developer tools and reference implementations for the MFOS platform.

MFOS/
├── mfos/                      # MFOS Platform Developer Tools
│   ├── app-template/          # Official app starter template
│   └── examples/
│       └── calculator/        # Reference implementation
├── hushme/                    # HushMe Ecosystem
│   └── store-apps/            # App submissions for HushMe Store
├── docs/
│   └── adr/                   # Architecture Decision Records (mirrored from mxcore.tech)
│       └── 0013-namespace-policy.md
└── README.md

Architecture Decision Records

Canonical namespace and identifier policy for MFOS bundles, WebApps and Matrix vendor extensions is defined in ADR-0013. Every example and app-template in this repository conforms to that policy. In particular, bundle IDs follow tech.{company-slug}.{app-slug}:

• tech.matrixfamilyinc.* is reserved for first-party Matrix Family Inc. bundles
• tech.example.* is used by the examples in this repository (never published to HushMe Store production)

MFOS Developer Tools

Tools for building applications on the MFOS platform.

app-template

Official starter template for MFOS applications. Includes all required configuration, type definitions, and best practices.

cd mfos/app-template
bun install
bun run dev

examples/calculator

Complete calculator application demonstrating:

• MFOS API integration
• State persistence with mfos.storage
• Localization with mfos.i18n
• UI components from mfos.ui.components
• CSS variables for theming

cd mfos/examples/calculator
bun install
bun run dev

HushMe Store Apps

Submit your MFOS applications to HushMe Store.

See hushme/store-apps for submission guidelines and requirements.

Documentation

Full documentation available at mfos.tech.

Community

• Discussions - questions, ideas, community apps
• Issues - bugs and actionable reports

License

Only MFOS Developer Tools (mfos/) are licensed under the MIT License. Other parts of the repository may have different licensing terms.