Every thing you need to know about Stump

In category: ← Document Management / E-books

About Stump

A fast, free and open source comics, manga and digital book server with OPDS support.

Github stats:

Commits: 268
366
18
Latest commit: Oct 22, 2022

Deploy this app to Linode with a free $100 credit!

Languages/Platforms/Technologies:

Rust

Lincenses:

More about Stump

Stump is a free and open source comics, manga and digital book server with OPDS support, created with Rust, Axum, Prisma and React.

Screenshot of Stump

Table of Contents

- [Roadmap 🗺](#roadmap-) - [Getting Started 🚀](#getting-started-) - [Developer Guide 💻](#developer-guide-) - [Where to start?](#where-to-start) - [Project Structure 📦](#project-structure-) - [/apps](#apps) - [/common](#common) - [/core](#core) - [Similar Projects 👯](#similar-projects-) - [Acknowledgements 🙏](#acknowledgements-)

🚧 Disclaimer 🚧: Stump is very much an ongoing WIP, under active development. Anyone is welcome to try it out, but please keep in mind that installation and general usage at this point should be for testing purposes only. Do not expect a fully featured, bug-free experience if you spin up a development environment or use a testing Docker image. Before the first release, I will likely flatten the migrations anyways, which would break anyone's Stump installations. If you'd like to contribute and help expedite Stump's first release, please see the contributing guide for more information on how you can help. Otherwise, stay tuned for the first release!

Roadmap 🗺

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
🔎 Versitile full-text search
🔐 Role-based access-control with managed user accounts and configurable privileges
🚀 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 self-documented REST API, so community tools and scripts can interact with Stump
🌈 And more!

Things you can expect to see after the first release:

🖥️ Desktop app (Tauri)
📱 Mobile app (Tachiyomi and/or custom application)
📺 A utility TUI for managing a Stump instance from the command line

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, feel free to view the FAQ page. If you're interested in tracking the development of specific features, you can take a look at my personal task board.

Getting Started 🚀

Stump isn't ready for normal, non-development usage yet. Once a release has been made, this will be updated. For now, follow the Developing section to build from source and run locally.

There is a docker image available for those interested. However, this is only meant for testing purposes and will not be updated frequently, so do not expect a fully featured, bug-free experience if you spin up a container.

For more information about getting started, how Stump works and how it manages your library, and much more, please visit stumpapp.dev.

Developer Guide 💻

Contributions are very encouraged and welcome! Please review the contributing guide for more thorough information on how to get started.

A quick summary of the steps required to get going:

Install pnpm, rust and node
If you're running Windows, you will need Visual C++
If you're running macOS on Apple Silicon, you'll need to install Rosetta
Install cargo-watch
Run the setup:

pnpm run setup

Start one of the apps:

pnpm dev:web # Web app
pnpm dev:desktop # Desktop app

And that's it!

Where to start?

If you aren't sure where to start, I recommend taking a look at the task board. This is where I track the broader development items for Stump. It is mostly for my own personal organization, but should still hopefully give you an idea of what needs work.

You can also check out the v0.1.0 milestone for a more filtered list of major features planned for that 0.1.0 release.

Some other good places to start:

Translation, so Stump is accessible to non-English speakers.
An automated translation system would be immensely helpful! If you're knowledgeable in this area, please reach out!
Writing comprehensive integration tests.
look here
Designing and/or implementing UI elements.
Docker build optimizations (it is currently horrendously slow).
CI pipelines / workflows (given above issue with Docker is resolved).
And lots more!

I keep track of all non-code contributions in the CONTRIBUTORS.md file. If you contribute in that manner, please add yourself to the list!

Project Structure 📦

Stump has a monorepo structure that follows a similar pattern to that of Spacedrive.

/apps

desktop: A Tauri application.
server: An Axum server.
web: The React application that is served by the Axum server.

/common

client: Everything needed to create a react-based client for Stump. Contains Zustand and React Query configuration, used by the interface package, as well as the generated TypeScript types.
config: Configuration files for the project, e.g. tsconfig.json, etc.
interface: Stump's main React-based interface, shared between the web and desktop applications.

/core

core: Stump's 'core' functionality is located here, written in Rust. The server was previously part of the core, but was extracted to support integration testing.

Similar Projects 👯

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:

Komga
Kavita
audiobookshelf (Audio books, Podcasts)
Dim (Video, Audio) (✨Rust✨)
tonbun (Reading and downloading manga) (✨Rust✨)

Acknowledgements 🙏

Komga is a huge inspiration for Stump, an amazing comics/manga media server written in Kotlin.
Brendonovich for building prisma client rust, which allows me to use Prisma with Rust. Stump previously used SeaORM, but the DX simply can't compare to Prisma.