Attempt at a book and maybe more cataloging web application
- Elixir 82.5%
- HTML 15.5%
- JavaScript 0.8%
- CSS 0.5%
- Dockerfile 0.4%
- Other 0.3%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .forgejo/workflows | ||
| assets | ||
| config | ||
| docs | ||
| lib | ||
| priv | ||
| rel/overlays/bin | ||
| scripts | ||
| test | ||
| .coveralls.exs | ||
| .dockerignore | ||
| .env.sample | ||
| .formatter.exs | ||
| .gitignore | ||
| AGENTS.md | ||
| CHANGELOG.md | ||
| CLAUDE.md | ||
| cliff.toml | ||
| docker-compose.yaml | ||
| Dockerfile | ||
| LICENSE | ||
| mise.local.sample.toml | ||
| mise.toml | ||
| mix.exs | ||
| mix.lock | ||
| README.md | ||
FuzzyCatalog
About
A book catalogging application that allows you to keep track of the books you own, both digital and physical.
Under Development
This is still pretty heavily under development, but closing in on something I think I can personally use. I hope it may be useful to others who were looking for something to catalog their physical books & more with. Hopefully more to come!
Features
- Barcode scanning of physical books via keyboard input scanners (webcam one may still work but have not had much luck with it)
- Ability to sync with digital libraries, currently from Audiobookshelf (via API), Calibre (via actual path to library files), & BookLore via API
- Adding books via title or ISBN pulls metadata from Open Library or Google Books (Library of Congress available but not sure it's worth using)
- Ebook libraries: point it at folders of EPUB, PDF, MOBI/AZW/AZW3 & CBZ files (Calibre libraries included) and it reads their metadata and covers, links them to books in the catalog, and lets you download them. Set up in Admin → Libraries; folders can be watched for changes or scanned on a schedule
Environment Setup
| Env | Usage |
|---|---|
| DATABASE_URL | REQUIRED postgres database URL, i.e.: ecto://user:password@host:port/database |
| SECRET_KEY_BASE | REQUIRED random secret |
| PHX_HOST | domain to use (i.e. localhost) |
| PORT | port to use, default is 4000 |
| ERL_MAX_PORTS | Max open ports/files for the BEAM. The Docker image sets 65536 so hosts with an unlimited ulimit -n don't use ~2 GB of RAM at idle; raise it if you need more |
| AUDIOBOOKSHELF_URL | URL to an instance of Audiobookshelf for syncing |
| AUDIOBOOKSHELF_API_KEY | API key for Audiobookshelf |
| AUDIOBOOKSHELF_LIBRARIES | Comma separated list of library names to sync from Audiobookshelf |
| CALIBRE_LIBRARY_PATH | Path to Calibre library files, including ebooks & metadata.db file |
| BOOKLORE_URL | URL for a BookLore instance to sync with |
| BOOKLORE_USERNAME | Username for a BookLore |
| BOOKLORE_PASSWORD | Password for BookLore |
Possible TODO
- Expose mail sending configuration (Swoosh settings) to ENV
- Support for other digital libraries like Kavita, Calibre-Web (OPDS), and more
- OPDS feed for ebook libraries
- Explore adding support for other physical items like movies or games
Local Dev
To start your Phoenix server:
- Install poppler-utils (
pdfinfoandpdftoppm) for PDF metadata and covers, and on Linux inotify-tools for watching ebook libraries - Run
mix setupto install and setup dependencies - Start Phoenix endpoint with
mix phx.serveror inside IEx withiex -S mix phx.server
Now you can visit localhost:4000 from your browser.
Ready to run in production? Please check our deployment guides.
Learn more
- Official website: https://www.phoenixframework.org/
- Guides: https://hexdocs.pm/phoenix/overview.html
- Docs: https://hexdocs.pm/phoenix
- Forum: https://elixirforum.com/c/phoenix-forum
- Source: https://github.com/phoenixframework/phoenix