myxelium/Toju
1
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects 2 Releases 25 Wiki Activity

feat: Add browser documentation

Browse Source
This commit is contained in:
SocksOnHead
2026-04-29 17:15:01 +02:00
parent d261bac0ed
commit 3d81c34159
29 changed files with 19981 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -13,13 +13,15 @@ MetoYou is a desktop-first chat stack managed as an npm monorepo. The repository
| `server/` | Signaling server, server-directory API, and websocket runtime | [server/README.md](server/README.md) |
| `e2e/` | Playwright end-to-end coverage for the product client | [e2e/README.md](e2e/README.md) |
| `website/` | Angular 19 marketing site served separately from the product client | [website/README.md](website/README.md) |
| `docs-site/` | Docusaurus app and plugin documentation served by the Electron Local API | [docs-site/docs/intro.md](docs-site/docs/intro.md) |
## Install
1. Run `npm install` from the repository root.
2. Run `cd server && npm install` for the server package.
3. If you need to work on the marketing site, run `cd website && npm install`.
4. Copy `.env.example` to `.env`.
4. If you need to work on the Docusaurus docs, run `cd docs-site && npm install`.
5. Copy `.env.example` to `.env`.
## Configuration
@@ -36,8 +38,9 @@ MetoYou is a desktop-first chat stack managed as an npm monorepo. The repository
- `npm run electron:dev` starts the Angular product client and Electron together.
- `npm run server:dev` starts only the server with reload.
- `npm run build` builds the Angular product client to `dist/client`.
- `npm run build:docs` builds the Docusaurus documentation site to `docs-site/build`.
- `npm run build:electron` builds the Electron code to `dist/electron`.
- `npm run build:all` builds the product client, Electron, and server.
- `npm run build:all` builds the product client, Docusaurus docs, Electron, and server.
- `npm run test` runs the product-client Vitest suite.
- `npm run lint` runs ESLint across the repo.
- `npm run lint:fix` formats Angular templates, sorts template properties, and applies ESLint fixes.
@@ -54,6 +57,7 @@ MetoYou is a desktop-first chat stack managed as an npm monorepo. The repository
| `server/src/` | Express app, websocket runtime, config, CQRS, and persistence layers |
| `e2e/` | Playwright tests, helpers, fixtures, and page objects |
| `website/src/` | Marketing-site pages, assets, and SSR entry points |
| `docs-site/` | Docusaurus source for Electron-hosted application and plugin documentation |
| `tools/` | Build, release, formatting, and packaging scripts |
## Product Client Docs