https://github.com/xushaohua/pengzu

Personal ebook library
https://github.com/xushaohua/pengzu

Last synced: 14 days ago
JSON representation

Personal ebook library

• Host: GitHub
• URL: https://github.com/xushaohua/pengzu
• Owner: XuShaohua
• License: gpl-3.0
• Created: 2022-08-09T02:05:46.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-19T04:30:15.000Z (4 months ago)
• Last Synced: 2024-11-13T00:20:44.207Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 21.9 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# About

![Build status][build-status]

![Minimum rustc version][rustc-version]

Personal ebook library.

Features:

- Support [CLC][clc], Chinese Library Classification a.k.a. 中图分类法

- Support tag hierachy

- Manage millions of books without latency

## How to deploy

The simple way is to deploy with docker-compose.

A template yaml file is located [here](docker/docker-compose.yml).

Modify it based on your environment.

Currently only PostgreSQL is supported.

## Import calibre library

To import calibre library, run `backend --bin import-library /path/to/calibre/library`. 

If it is deployed in docker, switch to docker app with `docker exec pengzu_pengzu_app_1 /bin/bash`

and run this command.

Remember to mount calibre library in volume.

## Screenshot

![screenshot](./tools/screenshot.png)

## License

This project is released in [General Public License](LICENSE).

[build-status]: https://github.com/PengzuLibrary/pengzu/actions/workflows/rust.yml/badge.svg

[rustc-version]: https://img.shields.io/badge/rustc-1.52+-yellow.svg

[clc]: https://en.wikipedia.org/wiki/Chinese_Library_Classification