feat: Official v1.0 Launch with GitHub Actions, Cross-platform releases, and offline reading

Author: musprodev

.github/workflows/release.yml

@@ -0,0 +1,67 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build-and-release:
+    name: Build & Release
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            artifact_name: sage
+            asset_name: sage-linux-x86_64.tar.gz
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+            artifact_name: sage.exe
+            asset_name: sage-windows-x86_64.zip
+          - os: macos-latest
+            target: x86_64-apple-darwin
+            artifact_name: sage
+            asset_name: sage-macos-x86_64.tar.gz
+          - os: macos-latest
+            target: aarch64-apple-darwin
+            artifact_name: sage
+            asset_name: sage-macos-aarch64.tar.gz
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.target }}
+
+      - name: Cache dependencies
+        uses: Swatinem/rust-cache@v2
+        with:
+          key: ${{ matrix.target }}
+
+      - name: Build binary
+        run: cargo build --release --locked --target ${{ matrix.target }}
+
+      - name: Package Release (Linux/macOS)
+        if: matrix.os != 'windows-latest'
+        run: |
+          cd target/${{ matrix.target }}/release
+          tar -czvf ../../../${{ matrix.asset_name }} ${{ matrix.artifact_name }}
+
+      - name: Package Release (Windows)
+        if: matrix.os == 'windows-latest'
+        run: |
+          cd target\${{ matrix.target }}\release
+          Compress-Archive -Path ${{ matrix.artifact_name }} -DestinationPath ..\..\..\${{ matrix.asset_name }}
+
+      - name: Upload binaries to Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: ${{ matrix.asset_name }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,42 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# (Since Sage is an executable binary, we SHOULD commit Cargo.lock to ensure reproducible builds for users)
+# Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# Sage specific
+sage.db
+sage.db-journal
+*.epub
+*.log
+
+# IDEs and Editors
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS specific
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Temp / Scratch files
+.agents/
+skills-lock.json
+refactor_ui.py
+scratch
+scratch.rs
+scratch_test/
+test_fetch.rs
+test_scraper.rs
+*.py

README.md

@@ -1,32 +1,52 @@
-# Sage
+<div align="center">
+
+# 📖 Sage
+
+**A blazingly fast, highly customizable terminal-based web novel reader.**
+
+[![Release](https://img.shields.io/github/v/release/musprodev/sage?style=for-the-badge&color=success)](https://github.com/musprodev/sage/releases/latest)
+[![Rust](https://img.shields.io/badge/rust-1.80%2B-blue.svg?style=for-the-badge)](https://www.rust-lang.org)
+[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macOS%20%7C%20windows-lightgrey?style=for-the-badge)](#)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](LICENSE)
+
+<!-- Replace the link below with the actual URL to your recorded GIF of Sage in action -->
+![Sage in Action](https://raw.githubusercontent.com/musprodev/sage/main/assets/demo.gif)
+
+</div>
 
 Sage is a high-performance, terminal-based user interface (TUI) web novel reader written in Rust. It utilizes the powerful `ratatui` crate for rendering and features an advanced asynchronous scraping engine designed to bypass Cloudflare and directly fetch full chapter catalogs from sources like NovelBuddy.
 
-## Features
+## ✨ Features
 
 - **Blazing Fast TUI:** Built with Rust and `ratatui`, offering an incredibly responsive, keyboard-driven interface inspired by `btop`.
 - **Advanced Scraping:** Uses `primp` with Chrome V144 impersonation to seamlessly bypass Cloudflare and interact with hidden API endpoints, fetching entire novel chapter lists (1000+ chapters) instantly.
+- **True Offline Reading:** Background download your favorite novels directly into your local database. Sage will intelligently load texts from your hard drive if available, allowing you to read seamlessly without an internet connection.
 - **Local SQLite Library:** Persists your novel progress, bookmarks, and downloaded chapters locally.
-- **Storage Manager:** An integrated `ncdu`-style storage manager lets you visualize disk usage per novel and instantly clear downloaded caches to free up space.
+- **Storage Manager:** An integrated `ncdu`-style storage manager lets you visualize disk usage per novel, set custom cross-platform export directories, and instantly clear downloaded caches to free up space.
 - **Premium Reader Experience:** A highly customizable reader view that supports:
   - Dynamic margins and text-width constraints (Narrow, Medium, Wide, Full).
   - Customizable line and paragraph spacing (`Compact` mode removes blank lines and indents paragraphs).
   - Reader-specific color themes (Sepia, Paper, Soft Dark).
   - Text alignment toggles.
-- **EPUB Export:** Seamlessly export fully downloaded novels into well-formatted EPUB files for your e-reader.
+- **EPUB Export:** Seamlessly export fully downloaded novels into well-formatted EPUB files for your e-reader (saved to your custom Export Directory).
 
-## Installation
+## 🚀 Installation
 
-### Prerequisites
+### Download Pre-compiled Binaries (Recommended)
 
-Ensure you have the Rust toolchain installed. If not, install it via [rustup](https://rustup.rs/):
+Sage automatically builds and bundles standalone binaries for Windows, macOS, and Linux on every release!
 
-```bash
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-```
+1. Head over to the [GitHub Releases page](https://github.com/musprodev/sage/releases).
+2. Download the compressed archive for your operating system:
+   - **Linux:** `sage-linux-x86_64.tar.gz`
+   - **macOS:** `sage-macos-x86_64.tar.gz` (or `aarch64` for Apple Silicon)
+   - **Windows:** `sage-windows-x86_64.zip`
+3. Extract the archive and place the `sage` executable in your system's `PATH`.
 
 ### Building from Source
 
+If you prefer to compile from source, ensure you have the [Rust toolchain](https://rustup.rs/) installed.
+
 Clone the repository and build the release binary:
 
 ```bash

src/app.rs

@@ -256,15 +256,13 @@ impl App {
         self.is_loading = true;
 
         // Optimistically load from DB first
-        if let Some(novel) = &self.current_novel {
-            if let Ok(db_chapters) = self.db().get_novel_chapters(&novel.id) {
-                if !db_chapters.is_empty() {
+        if let Some(novel) = &self.current_novel
+            && let Ok(db_chapters) = self.db().get_novel_chapters(&novel.id)
+                && !db_chapters.is_empty() {
                     self.chapters = db_chapters;
                     self.is_loading = false;
                     self.status_message = String::from("Loaded chapters from library.");
                 }
-            }
-        }
 
         if self.is_loading {
             self.status_message = String::from("Fetching chapter list from web...");
@@ -284,15 +282,13 @@ impl App {
     pub fn load_selected_chapter(&mut self) {
         if let Some(chapter) = self.chapters.get(self.selected_chapter).cloned() {
             // First check if DB has the content
-            if let Ok(db_chapters) = self.db().get_novel_chapters(&chapter.novel_id) {
-                if let Some(db_chap) = db_chapters.into_iter().find(|c| c.id == chapter.id) {
-                    if let Some(content) = db_chap.content {
+            if let Ok(db_chapters) = self.db().get_novel_chapters(&chapter.novel_id)
+                && let Some(db_chap) = db_chapters.into_iter().find(|c| c.id == chapter.id)
+                    && let Some(content) = db_chap.content {
                         self.current_chapter_content = Some(content);
                         self.scroll_offset = 0;
                         return; // Found locally!
                     }
-                }
-            }
 
             // Fallback to in-memory content or trigger web fetch
             if let Some(content) = chapter.content {
@@ -307,7 +303,7 @@ impl App {
 
     pub fn trigger_download_chapter(&mut self, chapter_id: String, chapter_url: String) {
         self.is_loading = true;
-        self.status_message = format!("Downloading chapter…");
+        self.status_message = "Downloading chapter…".to_string();
 
         let provider = Arc::clone(&self.provider);
         let tx = self.event_tx.clone();
@@ -390,11 +386,7 @@ impl App {
             AppEvent::DownloadProgress(novel_id, current, total) => {
                 self.downloads_progress.insert(novel_id.clone(), (current, total));
                 self.status_message = format!("Downloading '{}': {}/{} chapters", novel_id, current, total);
-                if current == total {
-                    self.is_loading = false;
-                } else {
-                    self.is_loading = true;
-                }
+                self.is_loading = current != total;
             }
 
             AppEvent::ExportCompleted(msg) => {
@@ -435,13 +427,11 @@ impl App {
 
     /// Try saving the reading progress if we are in Reading mode.
     pub fn try_save_progress(&mut self) {
-        if self.current_pane == ActivePane::Reading {
-            if let Some(novel) = &self.current_novel {
-                if let Some(chapter) = self.chapters.get(self.selected_chapter) {
+        if self.current_pane == ActivePane::Reading
+            && let Some(novel) = &self.current_novel
+                && let Some(chapter) = self.chapters.get(self.selected_chapter) {
                     let _ = self.save_reading_progress(&novel.id.clone(), &chapter.id.clone());
                 }
-            }
-        }
     }
 
     /// Load chapters for a novel from the local database (offline).
@@ -562,11 +552,19 @@ mod tests {
             search_query: String::new(),
             search_input_focused: true,
             selected_novel: 0,
+            selected_library_novel: 0,
             selected_chapter: 0,
             scroll_offset: 0,
             should_quit: false,
+            theme_index: 0,
+            reader_settings: crate::reader_settings::ReaderSettings::default(),
+            config: crate::config::AppConfig::load(),
+            storage_items: Vec::new(),
+            storage_selected: 0,
+            show_settings_panel: false,
 
             search_state: SearchState::Idle,
+            library_novels: Vec::new(),
             chapters: Vec::new(),
             current_novel: None,
             current_chapter_content: None,

src/config.rs

@@ -2,15 +2,11 @@ use serde::{Deserialize, Serialize};
 use std::path::PathBuf;
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Default)]
 pub struct AppConfig {
     pub export_dir: Option<PathBuf>,
 }
 
-impl Default for AppConfig {
-    fn default() -> Self {
-        Self { export_dir: None }
-    }
-}
 
 impl AppConfig {
     pub fn config_path() -> PathBuf {
@@ -23,13 +19,11 @@ impl AppConfig {
 
     pub fn load() -> Self {
         let path = Self::config_path();
-        if path.exists() {
-            if let Ok(content) = std::fs::read_to_string(&path) {
-                if let Ok(config) = serde_json::from_str(&content) {
+        if path.exists()
+            && let Ok(content) = std::fs::read_to_string(&path)
+                && let Ok(config) = serde_json::from_str(&content) {
                     return config;
                 }
-            }
-        }
         Self::default()
     }
 

src/db.rs

@@ -120,7 +120,7 @@ impl Database {
             "SELECT id, title, author, cover_url, source_url, description
              FROM novels WHERE id = ?1",
         )?;
-        
+
         let mut rows = stmt.query_map(params![novel_id], |row| {
             Ok(Novel {
                 id: row.get(0)?,
@@ -143,7 +143,7 @@ impl Database {
     pub fn get_all_novels(&self) -> Result<Vec<Novel>> {
         let mut stmt = self.conn.prepare(
             "SELECT id, title, author, cover_url, source_url, description
-             FROM novels ORDER BY title"
+             FROM novels ORDER BY title",
         )?;
 
         let rows = stmt.query_map([], |row| {
@@ -201,9 +201,9 @@ impl Database {
              JOIN chapters c ON n.id = c.novel_id
              WHERE c.is_downloaded = 1
              GROUP BY n.id
-             ORDER BY size_bytes DESC"
+             ORDER BY size_bytes DESC",
         )?;
-        
+
         let items = stmt.query_map([], |row| {
             let size: i64 = row.get(3).unwrap_or(0);
             Ok(crate::app::StorageItem {
@@ -216,15 +216,24 @@ impl Database {
 
         let mut result = Vec::new();
         for item in items {
-            result.push(item.map_err(|e| SageError::Database(e))?);
+            result.push(item.map_err(SageError::Database)?);
         }
         Ok(result)
     }
 
-        pub fn delete_novel(&self, novel_id: &str) -> Result<()> {
-        self.conn.execute("DELETE FROM novels WHERE id = ?1", rusqlite::params![novel_id])?;
-        self.conn.execute("DELETE FROM chapters WHERE novel_id = ?1", rusqlite::params![novel_id])?;
-        self.conn.execute("DELETE FROM reading_progress WHERE novel_id = ?1", rusqlite::params![novel_id])?;
+    pub fn delete_novel(&self, novel_id: &str) -> Result<()> {
+        self.conn.execute(
+            "DELETE FROM novels WHERE id = ?1",
+            rusqlite::params![novel_id],
+        )?;
+        self.conn.execute(
+            "DELETE FROM chapters WHERE novel_id = ?1",
+            rusqlite::params![novel_id],
+        )?;
+        self.conn.execute(
+            "DELETE FROM reading_progress WHERE novel_id = ?1",
+            rusqlite::params![novel_id],
+        )?;
         Ok(())
     }
 
@@ -264,12 +273,7 @@ impl Database {
     // ──────────────────────────── Progress ──────────────────────────
 
     /// Saves (or updates) the reading progress for a novel.
-    pub fn save_progress(
-        &self,
-        novel_id: &str,
-        chapter_id: &str,
-        offset: usize,
-    ) -> Result<()> {
+    pub fn save_progress(&self, novel_id: &str, chapter_id: &str, offset: usize) -> Result<()> {
         self.conn.execute(
             "INSERT INTO progress (novel_id, chapter_id, scroll_offset)
              VALUES (?1, ?2, ?3)
@@ -388,7 +392,10 @@ mod tests {
         db.upsert_chapter(&ch).unwrap();
 
         let chapters = db.get_novel_chapters("novel-1").unwrap();
-        assert_eq!(chapters[0].content.as_deref(), Some("Full chapter text here."));
+        assert_eq!(
+            chapters[0].content.as_deref(),
+            Some("Full chapter text here.")
+        );
         assert!(chapters[0].is_downloaded);
     }