docs: update all READMEs for v1.1.0
Add Electron desktop app section, document all 8 plugins, update features list (assets, super-buckets, find/replace, arrow nav, PDF upload), fix relay docs (chat shipped, not future), add missing API endpoints, correct electron data storage paths and php-bin fetch info. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
1 parent
d5f44370b6
commit
c5bf8b0407
4 files changed
+84
-31
No files matched your search
@@ -110,10 +110,23 @@ hyprcrd/
|
||||
│ │ └── vendor/ # marked.js, DOMPurify
|
||||
│ ├── plugins/ # Optional, drop-in plugin folders
|
||||
│ │ ├── canvas/ # ASCII art canvas editor
|
||||
│ │ ├── chat/ # Encrypted relay chat
|
||||
│ │ ├── collab-buckets/ # Collaborative bucket sync
|
||||
│ │ ├── email/ # Email overlay
|
||||
│ │ ├── gitea/ # Gitea issue integration
|
||||
│ │ ├── logseq-import/ # Logseq markdown importer
|
||||
│ │ ├── slideshow/ # Presentation mode
|
||||
│ │ └── tests/ # UI + state test runner
|
||||
│ └── uploads/ # User media (writable)
|
||||
├── relay/ # Relay service (mobile inbox + card sharing)
|
||||
│ ├── index.php # Single-file API + Mobile UI
|
||||
├── electron/ # Electron desktop app wrapper
|
||||
│ ├── main.js # Spawns PHP, creates BrowserWindow
|
||||
│ ├── router.php # PHP built-in server router
|
||||
│ ├── fetch-php.sh # Downloads static PHP binaries
|
||||
│ └── php-bin/ # Platform-specific PHP binaries
|
||||
├── relay/ # Relay service (multi-tenant messaging + collab)
|
||||
│ ├── index.php # Entry point + API dispatch
|
||||
│ ├── inc/ # Backend modules (bootstrap, crypto, auth, routes)
|
||||
│ ├── ui/ # Frontend (layout.php, style.css, app.js)
|
||||
│ ├── .htaccess # URL rewriting + data protection
|
||||
│ ├── Dockerfile
|
||||
│ └── dist.sh # Build relay distribution ZIP
|
||||
@@ -128,7 +141,7 @@ hyprcrd/
|
||||
- **Tags** written as `#tagname` or hierarchical `#parent/child` in card body, extracted automatically
|
||||
- **Markdown** with `[[Card Title]]` wiki-links, ```` ```gallery ```` image galleries, ```` ```tree ```` list views, ```` ```ascii ```` art canvas (via canvas plugin)
|
||||
- **Search** combining text and `#tag` filters (e.g. `#project meeting notes`)
|
||||
- **Image gallery** with orphan detection and fullscreen viewer
|
||||
- **Assets gallery** (images, audio, PDFs) with orphan detection and fullscreen viewer
|
||||
- **Split view** showing tag-related and content-related cards
|
||||
- **Import/Export** as JSON+media ZIP or Obsidian/Logseq-compatible markdown vault
|
||||
- **Drag & drop** card reordering and grouping
|
||||
@@ -141,7 +154,14 @@ hyprcrd/
|
||||
- **Notification banner** for upcoming events, birthdays, overdue tasks
|
||||
- **Board split view** with side-by-side preview
|
||||
- **Superview** compact multi-column list with hover cards
|
||||
- **Keyboard shortcuts**: `Ctrl+K` search, `F1` help, `Shift+scroll` zoom, arrow keys in autocomplete
|
||||
- **Super-buckets** — nest buckets one level deep with a dropdown for children
|
||||
- **Card groups** — drag-to-group, join multiple cards, dissolve
|
||||
- **Context menu** — color, tags, copy text, mark done, join cards, make ticket (gitea)
|
||||
- **Find & replace** — in-card (Ctrl+H) and across all cards (Ctrl+Shift+H via search)
|
||||
- **Arrow key navigation** on the board with Enter to open
|
||||
- **PDF upload** in the editor toolbar
|
||||
- **Keyboard shortcuts**: `Ctrl+K` search, `F1` help, `?` shortcut reference, arrow keys, 1–9 bucket switch
|
||||
- **Electron desktop app** — standalone AppImage/DMG/NSIS with bundled PHP, no server needed
|
||||
|
||||
## Plugins
|
||||
|
||||
@@ -150,7 +170,13 @@ hyprcrd has a drop-in plugin system. A plugin is just a folder under `public/plu
|
||||
### Bundled plugins
|
||||
|
||||
- **`canvas/`** — ASCII art canvas editor. Adds a toolbar button + ` ```ascii ` fenced block. Draw with brush, line, rectangle, ellipse, fill, and text tools using a monospace character grid.
|
||||
- **`tests/`** — UI + state test runner (40+ test files). Loaded only when `?test` is in the URL or `Ctrl+Shift+T` is pressed, so production users pay no cost for it.
|
||||
- **`chat/`** — Encrypted chat between relay tenants. Footer flyout with delivery + read receipts.
|
||||
- **`collab-buckets/`** — Collaborative buckets shared between relay tenants with exclusive card locking and E2E encrypted sync.
|
||||
- **`email/`** — Email overlay (toggled with `M` key).
|
||||
- **`gitea/`** — Gitea integration: create issues from cards, link to repos.
|
||||
- **`slideshow/`** — Slideshow presentation mode for cards with `slide-image` blocks.
|
||||
- **`logseq-import/`** — Import Logseq markdown journals and pages.
|
||||
- **`tests/`** — UI + state test runner (40+ test files). Loaded only when `Ctrl+Shift+Alt+T` is pressed, so production users pay no cost for it.
|
||||
|
||||
### Plugin layout
|
||||
|
||||
@@ -417,9 +443,8 @@ Starts hyprcrd on `http://localhost:8088` and the relay on `http://localhost:808
|
||||
master key lives outside the DB in a chmod-600 file
|
||||
- **24-hour ephemeral**: messages and attachments auto-delete after a
|
||||
day. Cards extracted in hyprcrd are the long-term store
|
||||
- **Future: end-to-end encrypted chat** between tenants is planned and
|
||||
will require per-pair key exchange — see `relay/README.md` for the
|
||||
roadmap
|
||||
- **Encrypted chat**: tenant-to-tenant chat with delivery + read receipts
|
||||
(via chat plugin). Per-pair E2E key exchange is on the roadmap
|
||||
|
||||
### Relay Security
|
||||
|
||||
@@ -451,6 +476,26 @@ your next visit. You'll need to:
|
||||
The old `relay_key` was bcrypt-hashed and cannot be recovered, so all
|
||||
client secrets need to be reissued.
|
||||
|
||||
## Electron Desktop App
|
||||
|
||||
hyprcrd can run as a standalone desktop app via Electron — no web server needed.
|
||||
|
||||
```bash
|
||||
cd electron
|
||||
./fetch-php.sh # download static PHP binary (~20MB)
|
||||
npm install
|
||||
npm start # dev mode
|
||||
npm run dist # build AppImage / DMG / NSIS
|
||||
```
|
||||
|
||||
The app bundles a static PHP binary per platform and stores user data (database + uploads) outside the app bundle:
|
||||
|
||||
- **Linux**: `~/.config/hyprcrd/data/`
|
||||
- **macOS**: `~/Library/Application Support/hyprcrd/data/`
|
||||
- **Windows**: `%APPDATA%/hyprcrd/data/`
|
||||
|
||||
See [`electron/README.md`](electron/README.md) for details.
|
||||
|
||||
## Rebuilding Tailwind CSS
|
||||
|
||||
After changing Tailwind utility classes in HTML or JS files:
|
||||
|
||||
Reference in new issue
Block a user