41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
---
|
|
slug: /
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# MetoYou Documentation
|
|
|
|
MetoYou is a desktop-first chat stack with a peer-to-peer product client, an Electron desktop shell, a Node signaling server, local persistence, realtime voice/video, a local automation API, and a client plugin runtime.
|
|
|
|
The product experience is intentionally close to a modern team chat application:
|
|
|
|
- servers organize communities or workspaces;
|
|
- text channels keep room conversations scoped and searchable;
|
|
- direct messages stay separate from server context;
|
|
- voice, video, and screen sharing use WebRTC peer connections;
|
|
- invite links help members join the current server;
|
|
- local desktop settings control data, updates, plugins, and automation access.
|
|
|
|
The Electron app also hosts this documentation. The docs endpoint is not a separate web server process: it is served from the same opt-in local HTTP server used for the Local API, and it only serves static files generated by Docusaurus.
|
|
|
|
## What Is Included
|
|
|
|
| Area | What it covers |
|
|
| --- | --- |
|
|
| Product client | Login, server discovery, channels, messages, voice, direct messages, themes, and plugin UI. |
|
|
| Desktop shell | Window controls, notifications, tray behavior, app data import/export, updates, local plugins, and hosted documentation. |
|
|
| Local HTTP API | A loopback-first API for local scripts and tools, with OpenAPI and Scalar reference docs. |
|
|
| Plugin runtime | Browser-safe client plugins with explicit capabilities, lifecycle hooks, UI contributions, data storage, message bus, and server plugin requirements. |
|
|
|
|
## Runtime Boundaries
|
|
|
|
MetoYou keeps responsibilities split by package:
|
|
|
|
- `toju-app/` is the Angular product client and plugin runtime.
|
|
- `electron/` is the main process, preload bridge, IPC, local persistence, and local HTTP host.
|
|
- `server/` is the signaling and server-directory service.
|
|
- `e2e/` contains Playwright coverage for browser and WebRTC workflows.
|
|
- `docs-site/` is this Docusaurus site.
|
|
|
|
The desktop documentation endpoint serves the static `docs-site/build` output. It does not run the Docusaurus development server inside Electron.
|