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

Files

T

neon 218f8d5dbd fix(books): list a book's formats from one ranked, read-along aware source

Every format chip, edition row and format menu now builds from shared helpers: content files
only, a read-along EPUB kept apart from a plain one, in the library's format priority, which
gains a read-along entry. Labels, colours and the chip each have one source, and cards, OPDS,
email, Kobo and the dashboard rank files the same way. Book detail file order is unchanged
because iOS builds its track queue from it.

2026-09-24 21:05:24 +00:00

.vscode

…

public

fix(reader): prevent duplicate media overlay playback

2026-09-22 11:38:28 +00:00

scripts

ci: make crowdin source synchronization deterministic

2026-09-15 13:11:24 +00:00

src

fix(books): list a book's formats from one ranked, read-along aware source

2026-09-24 21:05:24 +00:00

.editorconfig

…

.gitattributes

…

.gitignore

…

.oxlintrc.json

…

.prettierrc.json

…

components.json

…

env.d.ts

fix(notifications): enforce settings access permission

2026-08-21 16:01:56 +00:00

eslint.config.ts

feat: add read-aloud and media playback support

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

index.html

fix(csp): allow Google Fonts, blob workers, and jsDelivr in CSP directives

2026-05-15 01:15:28 +00:00

package.json

chore(deps): bump the production-dependencies group with 6 updates (#1441 )

2026-09-18 09:46:49 -06:00

pwa-assets.config.ts

feat(client): add PWA support with installability and cover caching

2026-05-12 20:53:21 +00:00

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

fix(library): only process books marked for rename in bulk rename

2026-06-17 23:14:30 +00:00

vite.config.ts

feat(cover): give books with both media separate ebook and audiobook covers

2026-09-23 19:55:25 +00: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.