patrick
e9fe18266d
Only src/ was covered, which is why it stayed clean while tests/ drifted to 38 findings. migrations/ stays out: its alembic template emits unused imports, so every generated revision would fail the gate.
Chitai - eBook Library Management
eBook library management application.
- Backend built with Python and Litestar
- Frontend built with Svelte 5 and SvelteKit
Key Features
- Libraries: Organize your eBooks into customizable libraries.
- Book Upload: Easily upload eBook files in common formats, with automatic metadata extraction.
- Personalized Bookshelves: Create and manage custom bookshelves (lists) within your libraries to categorize your eBooks.
- Built-in Readers: Integrated readers for EPUB and PDF files.
- Progress Tracking: Monitor your reading progress within each book.
- Search Functionality: Quickly find books based on title.
Getting Started
Prerequisites
- Docker
- Docker Compose
- (Optional) A text editor for modifying the
.envfile.
Installation (Production Deployment)
- Clone the repository:
git clone https://git.jaroszew.ski/patrick/chitai.git - Navigate to the project root:
cd chitai - Copy the example environment file:
cp .env.prod-example .env - Edit
.env. At minimum setCHITAI_TOKEN_SECRETto something random, and setCHITAI_ORIGINto the URL you will reach the app on — logging in fails with a 403 if it does not match. PinCHITAI_VERSIONto a release tag if you would rather not tracklatest. - Pull the released images:
docker compose pull - Run the Docker containers in detached mode:
docker compose up -d - Access the frontend at:
http://localhost:3000/
To build the images from source instead of pulling them, run docker compose build in place of
step 5.
Development
NixOS Development Environment
To utilize the NixOS development environment:
- Navigate to the project root in your terminal:
cd chitai - Enter the Nix shell:
nix-shell
Docker development containers are planned for a future release.