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

Files

T

neon 946855cd30 feat(library): read series from folders for comics and manga

Offer the one-folder-per-series layout Komga and Kavita use as a File as Book path-rule preset
rather than a new organization mode, so released iOS builds and both existing modes are unaffected.
Add a job that applies saved rules to books already in a library, and keep a run year such as
"Batman (2016)" when ComicInfo or a provider names the series without it.

Ref #1167
Ref #1918
Ref #839

2026-10-24 04:43:17 +00:00

.vscode

…

public

chore(client): default new users to Nostalgia and teal

2026-10-20 16:05:28 -06:00

scripts

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

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

src

feat(library): read series from folders for comics and manga

2026-10-24 04:43:17 +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

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

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.