mirror of https://github.com/bookorbit/bookorbit.git synced 2026-11-03 00:11:37 -06:00

Files

T

neon 7d823039b0 feat(metadata): rebuild book auto-fetch as library scopes with counts

Show the global rule and each library's own rule on Field Rules-style tabs, with live counts per
condition, the score histogram and the books a run would take. Store only what a library changes,
run every library with its own rule, and record each library's run. Also fix the DjVu queue test
that assumed which request waits, and inventory the DjVu reader routes.

2026-10-16 19:05:32 +00:00

.vscode

…

public

feat(client): replace the global header with a sidebar dock and command palette

2026-10-16 08:44:43 +00:00

scripts

style(client): unify modal backdrops with dedicated scrim tokens

2026-09-29 03:42:01 +00:00

src

feat(metadata): rebuild book auto-fetch as library scopes with counts

2026-10-16 19:05:32 +00:00

.editorconfig

…

.gitattributes

…

.gitignore

…

.oxlintrc.json

…

.prettierrc.json

…

components.json

…

env.d.ts

feat(client): replace the global header with a sidebar dock and command palette

2026-10-16 08:44:43 +00:00

eslint.config.ts

feat(library): rebuild the browse header as a title row and one command bar

2026-10-16 06:08:13 +00:00

index.html

feat(client): add the Nostalgia appearance style

2026-10-09 01:01:57 +00:00

package.json

security(deps): update dependencies and rebuild kepubify with go 1.27.2

2026-10-11 05:19:04 +00:00

pwa-assets.config.ts

…

README.md

build: move local development off port 3000

2026-09-23 18:18:51 +00:00

tsconfig.app.json

feat: add read-aloud and media playback support

2026-09-19 02:27:05 +00:00

tsconfig.json

…

tsconfig.node.json

…

tsconfig.vitest.json

…

vite.config.ts

fix(auth): recover from expired edge auth proxy sessions (#1557 )

2026-09-26 08:55:42 -06:00

vitest.config.ts

build: serialize test runs so concurrent agents cannot saturate the machine

2026-08-24 04:49:55 +00:00

README.md

BookOrbit - Client

Vue 3 SPA built with Vite and Tailwind CSS v4.

Running

From the repo root: pnpm dev (starts both server and client).

Client only: pnpm dev (from this directory). Runs at http://localhost:6263.

The Vite dev server proxies /api and /socket.io requests to the backend at localhost:6262.

IDE setup

VS Code: Install the Vue (Official) extension. Disable Vetur if installed.
WebStorm / IntelliJ: Vue support is built in. Enable TypeScript service for .vue files.
Browser: Install Vue.js devtools and enable Custom Object Formatters in DevTools settings.

Project layout

src/
├── features/           Feature modules (one folder per domain)
│   ├── auth/           Login, registration, password reset
│   ├── book/           Book detail, covers, metadata
│   ├── library/        Library management
│   ├── collection/     Book collections
│   ├── smart-scope/           Saved search views
│   ├── scanner/        Scan progress UI
│   ├── reader/         Book reader (epub, pdf, cbz)
│   ├── settings/       User settings
│   └── admin/          Admin panel (users, roles, settings)
├── components/         Shared components (header, sidebar, icons)
│   └── ui/             Reusable UI primitives (button, dialog, etc.)
├── composables/        Global composables
├── views/              Route-level page components
├── router/             Vue Router config and guards
├── lib/                Utilities (api client, helpers)
├── stores/             Pinia stores (theme only - prefer composables)
└── assets/             CSS, fonts, static assets

Testing

pnpm test:unit          # run unit tests
pnpm test:cov           # run unit tests with coverage

Key conventions

All components use <script setup lang="ts"> (Composition API only).
Feature state lives in composables (features/<name>/composables/use*.ts), not global stores.
HTTP calls use the native fetch API via src/lib/api.ts.
Styling with Tailwind CSS v4 utility classes. Theme tokens are CSS variables in src/assets/main.css.
Icons from @lucide/vue only.
Shared types imported from @bookorbit/types.