https://github.com/leozqin/local-library

A filesystem based ePub library
https://github.com/leozqin/local-library

astrojs docker docker-com ebooks epub fastapi python self-hosted typescript

Last synced: 6 days ago
JSON representation

A filesystem based ePub library

• Host: GitHub
• URL: https://github.com/leozqin/local-library
• Owner: leozqin
• Created: 2024-12-24T16:02:26.000Z (10 days ago)
• Default Branch: main
• Last Pushed: 2024-12-27T05:03:05.000Z (7 days ago)
• Last Synced: 2024-12-27T05:20:10.023Z (7 days ago)
• Topics: astrojs, docker, docker-com, ebooks, epub, fastapi, python, self-hosted, typescript
• Language: Astro
• Homepage: https://github.com/leozqin/local-library
• Size: 202 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Local Library

Local Library is a simple read-only ebook library that indexes your `epub` ebooks against a read-only file system and provides a nice UI to browse and download them.

# Running

## Dev

To start the API server, in the repository root, create a fresh Python 3.12 virtual environment. Then, install the `requirements.txt` in that venv. Then, run `fastapi dev` to start the API server.

To start the web interface, first install nodejs 22. Then, in a different terminal session, navigate to `web` and run `npm install`. Finally, run `npm run dev` to start the web interface on port 4321.

If you're using nix, you can install pre-reqs by doing `nix-shell nodejs_22 python312`.

## Docker

Modify [the Compose stack](docker-compose.yml) to your heart's content, and then run `docker compose up` to start the app.