Repository navigation
Getting Started
⚠️ There is nothing to install as a user yet — FreeLayer is architecture, scaffolding and documentation. "Getting started" today means understanding the project or contributing to it.
- Read FreeLayer in plain English — the no-jargon overview.
- Skim the Glossary — every term with its real implementation status.
- Check the Trust Center — what exists, what doesn't, what's verified.
Room → Capsule → Courier → Device.
You create a private room; its data lives on members' devices. Every update is sealed into a capsule (a digital envelope). Any courier can carry the capsule — an internet relay, a shared folder, a QR code, a USB stick — and none of them can read it. On arrival, only room members can open it.
The app's policy engine enforces the privacy rules in the core: what gets stored, what touches the network, what can be previewed, copied or shown. Stricter always wins.
git clone https://github.com/XGiammyX/freelayer.git
cd freelayer
pnpm install
pnpm typecheck && pnpm lint && pnpm test && pnpm build
pnpm audit:privacy # the privacy guardrailsNode.js ≥ 20 and pnpm ≥ 9 required. Full details: INSTALLATION.md.
A strictly-typed monorepo: 12 packages (core, privacy, storage, transports, crypto, protocol, capsules, rooms, ai, security, ui, sdk) and 4 app shells — all scaffolding with fail-closed placeholders. The crypto provider deliberately throws; the AI provider deliberately rejects; storage and transports refuse calls without a policy decision. That's the anti-bypass architecture, visible from the first line.
FreeLayer — foundation stage · not ready for real secrets · code AGPL-3.0-or-later, docs CC BY-SA 4.0 · canonical docs live in docs/
FreeLayer Wiki