Skip to content

Latest commit

 

History

History
206 lines (149 loc) · 9.53 KB

README.md

File metadata and controls

206 lines (149 loc) · 9.53 KB
Raw

Stump's logo. Description: A young individual sitting on a tree stump reading a book. Inspired by Stump's creator's childhood, where a large amount of his time was spent sitting on a tree stump reading his comic books.
Awesome Self-Hosted Docker Pulls

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

🚧 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. 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
  • 🔐 Granular 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 recommended 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:

  1. Install yarn, 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

  2. Install cargo-watch

  3. 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:

    yarn 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
 yarn web build
 # generate the Prisma client and Rust-TypeScript types
 cargo codegen # or cargo prisma generate --schema=./core/prisma/schema.prisma for just the Prisma client

  4. Start one of the apps:

    A few example commands are:

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

    Or just cargo for the server (and other Rust apps):

    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 current project board to see what's actively being worked on or planned.

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

  • Translation, so Stump is accessible to as many people as possible
  • Writing comprehensive tests
  • Designing and/improving UI/UX
  • Docker build optimizations, caching, etc
  • CI pipelines, automated releases and release notes, etc
  • And lots more!

Run in Postman

Project Structure 📦

Click to expand

Stump has a monorepo structure managed by yarn workspaces and cargo workspaces. The project is split into a number of different packages and crates, each with their own purpose:

Apps

Stand-alone applications that can be run independently, at /apps in the root of the project:

  • desktop: A React + Tauri desktop application
  • expo: A React Native application (#125)
  • server: An Axum HTTP server
  • web: A React application, the primary UI for both the built-in web app the server serves and the desktop app

The only exception to this is the docs app, which is a NextJS application and is located at /docs in the root of the project.

Core

A Rust crate containing Stump's core functionalities, at /core in the root of the project

Crates

Various Rust crates, at /crates in the root of the project:

  • 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 at /docs in the root of the project

Packages

Various TypeScript packages, at /packages in the root of the project:

  • 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
  • browser: A React component that is essentially the "main" UI for Stump on browser-based platforms. It is isolated in order to be re-used in the two browser-based apps: web and desktop
  • 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:

License 📝

Stump is licensed under the MIT License. This applies to the entire repository except for subfolders/packages which contain their own license file(s). In such cases, the license file(s) in the subfolder/package take precedence.