mirror of
https://github.com/rowboatlabs/rowboat.git
synced 2026-04-26 17:06:23 +02:00
strengthen repo verification and runtime coverage
Add clearer app docs plus targeted desktop, CLI, web, and worker tests so cross-surface regressions are caught earlier and the repo is easier to navigate.
This commit is contained in:
parent
2133d7226f
commit
4239f9f1ef
63 changed files with 3678 additions and 764 deletions
54
apps/x/README.md
Normal file
54
apps/x/README.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
# Rowboat Desktop App
|
||||
|
||||
`apps/x` is the primary local-first Rowboat desktop product. It is a nested `pnpm` workspace that packages the Electron app, renderer, preload bridge, shared contracts, and core knowledge/runtime logic.
|
||||
|
||||
## Workspace Layout
|
||||
|
||||
- `apps/main` - Electron main process
|
||||
- `apps/renderer` - React and Vite renderer UI
|
||||
- `apps/preload` - validated IPC bridge
|
||||
- `packages/shared` - shared schemas and IPC contracts
|
||||
- `packages/core` - workspace, knowledge graph, integrations, agents, and background services
|
||||
|
||||
## Local Development
|
||||
|
||||
Install dependencies:
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
Build shared dependencies used by the app:
|
||||
|
||||
```bash
|
||||
npm run deps
|
||||
```
|
||||
|
||||
Run the desktop app in development:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Useful verification commands:
|
||||
|
||||
```bash
|
||||
npm run lint
|
||||
npm run typecheck
|
||||
npm run test
|
||||
npm run verify
|
||||
```
|
||||
|
||||
## Build Notes
|
||||
|
||||
- `npm run deps` builds `shared`, `core`, and `preload`
|
||||
- `apps/main` bundles the Electron main process with esbuild for packaging
|
||||
- The renderer uses Vite and hot reloads during development
|
||||
|
||||
## Local Data Model
|
||||
|
||||
- Default work directory: `~/.rowboat`
|
||||
- Knowledge is stored as Markdown
|
||||
- Knowledge note history is Git-backed for transparent local versioning
|
||||
|
||||
If you are new to the repo, read the root `ARCHITECTURE.md` before making cross-surface changes.
|
||||
Loading…
Add table
Add a link
Reference in a new issue