{"id":14155081,"url":"https://github.com/oqurum/TheReader","last_synced_at":"2025-08-06T00:33:21.075Z","repository":{"id":54114854,"uuid":"474613878","full_name":"oqurum/TheReader","owner":"oqurum","description":"An organizer for you books (hopefully audio too) written in Rust Lang.","archived":false,"fork":false,"pushed_at":"2024-01-07T18:53:43.000Z","size":12997,"stargazers_count":19,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-01-07T19:50:55.185Z","etag":null,"topics":["book","books","organize","organizer","rust","rust-lang","sqlite"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oqurum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-03-27T11:13:08.000Z","updated_at":"2023-12-27T17:48:03.000Z","dependencies_parsed_at":"2024-01-07T19:57:21.591Z","dependency_job_id":null,"html_url":"https://github.com/oqurum/TheReader","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oqurum%2FTheReader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oqurum%2FTheReader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oqurum%2FTheReader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oqurum%2FTheReader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oqurum","download_url":"https://codeload.github.com/oqurum/TheReader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":215735785,"owners_count":15923388,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["book","books","organize","organizer","rust","rust-lang","sqlite"],"created_at":"2024-08-17T08:01:48.336Z","updated_at":"2024-08-17T08:04:36.987Z","avatar_url":"https://github.com/oqurum.png","language":"Rust","funding_links":[],"categories":["books"],"sub_categories":[],"readme":"# Book Reader\n\nAn organizer for your books that allows you to read them in your browser. With a focus on simplicity and ease of use. Currently only supports epub (cbz is almost impl. too) files.\n\nMy intention will be to make it [Plex](https://plex.tv) for Books.\n\nTODO:\n - Better Separation of books' Sections\n - Utilize sqlite transactions for multi table changes.\n - Implement database migrations\n - Cache \u0026 Clear external searches for each task ran\n\n\n# Running/Building\n\nTo run and build the application you need to do the following:\n\n1. [Install Rust](https://www.rust-lang.org/). It's used for coding this whole application.\n\n2. [Install Trunk](https://trunkrs.dev/#install). It's used for building the frontend.\n   - Ensure a C Linker is installed - Lazy? `sudo apt install build-essential` will install all essentials including the linker\n\n3. Add Wasm32 Target to Rust: `rustup target add wasm32-unknown-unknown` - Used for frontend\n\n## Git\nImport the submodules\n```bash\ngit submodule update --init\n```\n\n## Backend:\nInside **root folder** execute these commands:\n```bash\ncargo run --bin books-backend\n```\n\nThe server will now be hosted on `127.0.0.1:8084`\n\n### Known Errors:\n\nError: could not find system library 'openssl' required by the 'openssl-sys' crate\n- https://github.com/sfackler/rust-openssl/issues/855#issuecomment-450057552\n\n## Frontend:\nExecute one of these commands\n\nTo build:\n```bash\ncd crates/frontend\ntrunk build --public-url \"/dist\" -d \"../../app/public/dist\"\n```\n\nTo build and watch:\n```bash\ncd crates/frontend\ntrunk watch --public-url \"/dist\" -d \"../../app/public/dist\"\n```\n\n# Packaging\nPackaging will store the frontend in to the reader executable and extract files when ran.\n\n## Frontend:\nExecute this first\n\nTo build:\n```bash\ncd crates/frontend\ntrunk build --release --public-url \"/dist\" -d \"../../app/public/dist\"\n```\n\n## Backend:\nInside **root folder** execute these commands:\n\n```bash\ncargo build --bin backend-bundled --release --features=bundled\n```\n\nThe packaged executable will now be inside target/release\n\n\n# Gallery\n\n## Mobile View\n\n![Overview](https://i.thick.at/BustedButterfly562.png)\n![Library](https://i.thick.at/AttentRedTornado025.png)\n![Book View](https://i.thick.at/MonoculturalYarn453.png)\n![Book Reader](https://i.thick.at/MoonishBorsec836.png)\n\n## Desktop View\n\n### Overview\n\n![Overview](https://i.thick.at/DishonorableRJD2117.png)\n\n### Basic library viewer.\n\n![Home](https://i.thick.at/AntagonizingFleance243.jpeg)\n\n### Basic book viewer.\n\n![Book View](https://i.thick.at/AntispasmodicCodyJinks427.png)\n\n### Basic book reader.\n\n![Book Reader](https://i.thick.at/SightlyWalkersShots711.png)\n\n### It can even go fullscreen!\n\n![Book Reader Fullscreen](https://i.thick.at/EmeticEverythingEverything016.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foqurum%2FTheReader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foqurum%2FTheReader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foqurum%2FTheReader/lists"}