markdown-body entry-content container-lg" itemprop="text">

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

Table of Contents

Roadmap 🗺
Getting Started 🚀
Developer Guide 💻
- Where to start?
Project Structure 📦
- /apps
- /core
- /crates
- /docs
- /interface
- /packages
Similar Projects 👯

🚧 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 or bug-free experience. I will likely flatten the migrations immediately prior to the 0.1.0 release, which will break existing Stump databases. If you'd like to contribute and help expedite Stump's first release, please review the developer guide.

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
🔐 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 (look here)
🌈 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)

Feel free to reach out if you have anything else you'd like to see!

Getting Started 🚀

Stump isn't ready for normal usage yet. To give it a spin, it is reccommended to try the nightly Docker image. If you're interested in development, or trying it from source, you can follow the developer guide.

For more information about getting started, check out the guides available on the Stump website.

Developer Guide 💻

Contributions are very welcome! Please review the CONTRIBUTING.md before getting 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 script:
```
./scripts/system-setup.sh
```
This isn't strictly necessary, and is mostly beneficial for Linux users (it installs some system dependencies). Feel free to skip this step if you'd like, and instead just run:
```
pnpm run setup
```
This will build the React app, generate the Prisma client, and generate the Rust-TypeScript types. To do any of these individually, you can run:
```
 # build the React app
 moon run web:build
 # generate the Prisma client and Rust-TypeScript types
 moon run codegen:generate
```

Start one of the apps:

I use moonrepo for Stump's repository management. A few example commands are:

# run the webapp + server
moon run server:dev web:dev
# run the desktop app + server
moon run server:start desktop:dev
# run the docs website
moon run docs:dev

This isn't a requirement though! You can also run the apps directly with pnpm:

# run the webapp + server
pnpm dev:web
# run the desktop app + server
pnpm dev:desktop
# run the docs website
pnpm docs dev

Or just cargo for the server:

cargo run --package stump_server --bin stump_server

And that's it!

Where to start?

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.

In general, the following areas are good places to start:

Translation, so Stump is accessible to as many people as possible
- Crowdin is being used for translations
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!

Project Structure 📦

Stump has a monorepo structure managed by pnpm workspaces and moonrepo:

/apps

desktop: A React+Tauri application
mobile: A React Native application
server: An Axum HTTP server
web: A React application

/core

A Rust crate containing Stump's core functionalities

/crates

cli: A CLI library used in the server app
codegen: A small rust app that handles all of the code generation for Stump
integrations: A rust library containing integrations with other notification services
prisma-cli: A small wrapper rust app to run the Prisma CLI

/docs

A NextJS application for the Stump documentation site

/interface

A React component that is essentially the "main" UI for Stump. It is used in both the web and desktop apps

/packages

api: All of the API functions used by the client package
client: React-query config, hooks, and other client-side utilities
components: Shared React components for the web and desktop applications
types: Shared TypeScript types for interfacing with Stump's core and API

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:

audiobookshelf (Audio books, Podcasts)
Dim (Video, Audio) (✨Rust✨)
Kavita
Komga
Librum
oqurum (✨Rust✨)

License

stumpapp/stump

About

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

Sponsor this project

Contributors 10

Languages