audiobookroom

Crates.ioaudiobookroom
lib.rsaudiobookroom
version0.1.1
sourcesrc
created_at2024-02-02 21:04:15.308658
updated_at2024-02-11 19:55:06.654264
descriptionAudiobookroom, a simple and fast self-hosted audiobook server
homepage
repositoryhttps://github.com/audiobookroom/audiobookroom
max_upload_size
id1124731
size644,691
Jiangqiu Shen (shenjiangqiu)

documentation

README

A simple and fast Self-host Audiobook server and player written fully in rust

this is a simple hobby project built with leptos + axum + sea-orm + tailwind. It's simple but fast

compare to AudiobookShelf

  • very fast (that the reason I decide to write this for my own use): the AudiobookShelf would take 1-3s to change the page. while in audiobookroom. every operation are finished in 10ms.
  • very pool functionality: This is just an audio server and audio player, nothing else (like metadata fetch. Audio analysis)

features

  • record reading history and progress.
  • user and password protected.
  • the server and client are very lightweight, you could run it on your very old PC.

install and serve

  1. clone this repo
  2. Prepare the perquisites:
    1. pnpm: this project use tailwindcss, so pnpm is needed (or NPM, yarn as you like)
    2. cargo-leptos: cargo install cargo-leptos
    3. sea-orm-cli: cargo install sea-orm-cli
    4. just: cargo install just
  3. install the node_modules: pnpm -i
  4. fresh the database (only do this for the first time to run. This will erase all previous data): just fresh
  5. start the server:just serve
  6. read the output, the site should be served at http://127.0.0.1:3003

notes

  1. when you run with cargo leptos serve, it will read the config in Config.toml leptos config. Feel free to change
  2. when you run manually (read justfile (deploy) to know more how to run it manually). You should write your own config in .env file(please read leptos doc to know more about leptos config)
  3. Generally you should not listen to 127.0.0.1. But if you listen on 0.0.0.0. Make sure to use a reverse proxy to provide https connection: *this is very important

screenshots

  • login login

  • player player

  • addbook addbook

todo

  • there are a lot of things unfinished...
  • manage current user
  • implement profiles for authors and books.
  • prettify the UI
  • ...
Commit count: 0

cargo fmt