Table of Contents
🚧 Disclaimer 🚧: Stump is under active development and is an ongoing WIP. Anyone is welcome to try it out, but do not expect a fully featured, bug-free experience. Some features will be missing and/or broken. Additionally, I will likely flatten the migrations immediately prior to the
0.1.0release, which would break existing Stump databases. If you'd like to contribute and help expedite Stump's first release, please review the developer guide. Otherwise, stay tuned!
The following items are the major targets for Stump's first release:
- 📃 Full OPDS + OPDS Page Streaming support
- 📕 EPUB, PDF, and CBZ/CBR support
- 📚 Organize libraries with collections and reading lists
- 🔐 Role-based access-control with managed user accounts
- 🚀 Easy setup and deployment using Docker or bare metal
- 👀 Fully responsive, built-in UI with a dark mode
- 🏃 Low resource utilization with excellent performance
- 🧰 Easily consumable and documented REST API, so community tools and scripts can interact with Stump
- 🌏 Language support (see this issue)
- 🌈 And more!
Things you can expect to see after the first release:
- 🖥️ Cross-platform desktop app (Windows, Mac, Linux)
- 📖 Tachiyomi support
- 📱 In-house mobile app (Android, iOS)
- 🔎 Versitile full-text search (blocked by prisma#9414)
- 👥 Configurable book clubs (see this issue)
I am very open to suggestions and ideas, so feel free to reach out if you have anything you'd like to see!
For more information about getting started, how Stump works, how it manages your library, and much more, please visit stumpapp.dev.
Contributions are very encouraged and welcome! Please review the CONTRIBUTING.md before getting started.
A quick summary of the steps required to get going:
- Install pnpm, rust and node
- Install cargo-watch
- Run the setup:
pnpm run setup
- Start one of the apps:
I use moonrepo for Stump's repository management
# webapp + server moon run server:dev web:dev # desktop app + server moon run server:start desktop:dev # docs website moon run docs:dev
And that's it!
If you aren't sure where to start, I recommend taking a look at open issues. You can also check out the milestones page for a more curated list of issues that need to be addressed. I typically organize issues into milestones based on the non-patch version they will be released in.
Some other good places to start:
- Translation, so Stump is accessible to non-English speakers.
- Stump uses Crowdin for translations. You can find the project here.
- Writing comprehensive tests.
- Designing UI elements/sections or improving the existing UI/UX.
- Docker build optimizations, caching, etc.
- CI pipelines, automated releases and release notes, etc.
- And lots more!
desktop: A React+Tauri application.
docs: A NextJS application for the Stump documentation site.
mobile: A React Native application.
server: An Axum HTTP server.
web: A React application.
core: A Rust crate containing Stump's core functionalities.
api: All of the API functions used by the
client: React-query config, hooks, and other client-side utilities utilities.
components: Shared React components for the web and desktop applications.
interface: A React component responsible for the main UI layout for the web and desktop applications.
prisma-cli: A small rust app to run the Prisma CLI.
types: Shared TypeScript types for interfacing with Stump's core and API
There are a number of other projects that are similar to Stump, it certainly isn't the first or only digital book media server out there. If Stump isn't for you, or you want to check out similar projects in the rust and/or self hosting spaces, consider checking out these other open source projects: