https://github.com/claritas-rs/claritas

A minimal, keyboard-friendly EPUB reader for the desktop built with Rust and Dioxus.
https://github.com/claritas-rs/claritas

desktop-app dioxus ebook epub gui linux reader rust

Last synced: 2 months ago
JSON representation

A minimal, keyboard-friendly EPUB reader for the desktop built with Rust and Dioxus.

Host: GitHub
URL: https://github.com/claritas-rs/claritas
Owner: claritas-rs
License: mit
Created: 2026-02-12T04:09:54.000Z (5 months ago)
Default Branch: main
Last Pushed: 2026-03-02T18:18:52.000Z (4 months ago)
Last Synced: 2026-03-02T21:59:27.433Z (4 months ago)
Topics: desktop-app, dioxus, ebook, epub, gui, linux, reader, rust
Language: Rust
Homepage:
Size: 724 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

A minimalist, fast and keyboard-friendly EPUB & PDF reader built entirely in Rust, running as a native desktop app via Dioxus.

---

### What's new in v1.5.2

- Added **CSV import** for reading stats so users can restore exported history without losing data
- Enhanced **CSV export** with each book's last reading position (chapter/spread or page)
- Added per-book activity tracking and export fields for pages, chapters and finished books

**Full Changelog:** https://github.com/claritas-rs/claritas/compare/v1.5.1...v1.5.2

### Features

---

### Technologies

_{Dioxus • Tokio • Rayon • epub-rs • PDF.js • serde_json • base64 • image • rfd}

---

### Structure

```
Claritas/
├── install.sh # One-step installer (binary + icons + .desktop)
├── claritas_core/ # Library — EPUB parsing, progress & status persistence
│ └── src/
│ └── lib.rs
└── claritas_desktop/ # Desktop app — UI built with Dioxus
├── assets/
│ ├── icon.png # App icon (512 × 512)
│ ├── claritas.desktop # .desktop entry template
│ └── style.css
└── src/
├── main.rs # App root, sidebar, search & screen routing
├── library.rs # Library view — grid, sections, book cards, import menu
└── reader.rs # Reader view — two-page spread, pagination, status bar
```

---

### Getting Started

#### Development

```bash
# Clone the repository
git clone https://github.com/claritas-rs/claritas.git
cd Claritas

# Run in development mode
cargo run -p claritas_desktop

# Build for release
cargo build --release -p claritas_desktop
```

> **Note:** On first launch Claritas scans `~/Documents/Claritas` for EPUB/PDF files.
> To change the default directory, update the path in `claritas_desktop/src/main.rs`.

#### Benchmarks & Profiling

The project is equipped with micro-benchmarks for the Rust core and `tracing` telemetry for the Dioxus frontend.

**Core Benchmarks (Criterion):**
To measure the performance of the EPUB engine (loading chapters, highlighting search results, splitting pagination):
```bash
cargo bench -p claritas_core
```
*Note: This requires an EPUB file located at `claritas_core/tests/fixtures/alice.epub`.*

**Baseline Performance (Alice in Wonderland EPUB):**
- **Open and parse:** ~0.73ms
- **Extract chapter & resolve images:** ~0.87ms
- **Calculate pagination limits:** ~0.27ms
- **Full-text highlighting search:** ~11.0ms

**Desktop Profiling (Tracing):**
To measure the real-world execution time of the Dioxus frontend (e.g., how long it takes to scan the library or paint the Virtual DOM), simply run the app via the terminal. The performance telemetry will be printed to standard output:
```bash
cargo run -p claritas_desktop
```

---

### Installation (Linux)

The included `install.sh` script builds the release binary and sets up proper desktop integration — icon sizes, `.desktop` entry and a launcher in `~/.local/bin`.

```bash
# From the repository root
bash install.sh
```

What the script does:

| Step | Action |
| :--: | :----- |
| 1 | Runs `cargo build --release -p claritas_desktop` |
| 2 | Installs the binary to `~/.local/bin/claritas_desktop` |
| 3 | Copies the icon to `~/.local/share/icons/hicolor/x/apps/` for sizes 48, 64, 128 and 256 |
| 4 | Installs `claritas.desktop` to `~/.local/share/applications/` |
| 5 | Refreshes icon and desktop database caches |

After installation, Claritas will appear in your application launcher and can be pinned to the taskbar.

> **PATH note:** If `~/.local/bin` is not in your `$PATH`, the script will remind you to add
> `export PATH="$HOME/.local/bin:$PATH"` to your `~/.bashrc` or `~/.profile`.

---

### Usage

---

### Author

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/claritas-rs/claritas

Awesome Lists containing this project

README