2023-09-18 23:57:18 +00:00
|
|
|
# Book Manager
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
2023-09-19 23:29:55 +00:00
|
|
|
<a href="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_login.png">
|
|
|
|
|
<img src="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_login.png" width="30%">
|
2023-09-18 23:57:18 +00:00
|
|
|
</a>
|
2023-09-19 23:29:55 +00:00
|
|
|
<a href="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_home.png">
|
|
|
|
|
<img src="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_home.png" width="30%">
|
2023-09-18 23:57:18 +00:00
|
|
|
</a>
|
2023-09-19 23:29:55 +00:00
|
|
|
<a href="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_documents.png">
|
|
|
|
|
<img src="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_documents.png" width="30%">
|
2023-09-18 23:57:18 +00:00
|
|
|
</a>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
This is BookManager! Will probably be renamed at some point. This repository contains:
|
|
|
|
|
|
|
|
|
|
- [KOReader KOSync](https://github.com/koreader/koreader-sync-server) Compatible API
|
|
|
|
|
- KOReader Plugin (See `client` subfolder)
|
|
|
|
|
- WebApp
|
|
|
|
|
|
|
|
|
|
In additional to the compatible KOSync API's, we add:
|
|
|
|
|
|
|
|
|
|
- Additional APIs to automatically upload reading statistics
|
|
|
|
|
- Automatically upload documents to the server (can download in the "Documents" view)
|
|
|
|
|
- Automatic book cover metadata scraping (Thanks [OpenLibrary](https://openlibrary.org/))
|
2023-09-19 23:29:55 +00:00
|
|
|
- No JavaScript! All information is rendered server side.
|
|
|
|
|
|
|
|
|
|
# Server
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
| Environment Variable | Default Value | Description |
|
|
|
|
|
| -------------------- | ------------- | -------------------------------------------------------------------- |
|
|
|
|
|
| DATABASE_TYPE | SQLite | Currently only "SQLite" is supported |
|
|
|
|
|
| DATABASE_NAME | bbank | The database name, or in SQLite's case, the filename |
|
|
|
|
|
| DATABASE_PASSWORD | <EMPTY> | Currently not used. Placeholder for potential alternative DB support |
|
|
|
|
|
| CONFIG_PATH | /config | Directory where to store SQLite's DB |
|
|
|
|
|
| DATA_PATH | /data | Directory where to store the documents and cover metadata |
|
|
|
|
|
| LISTEN_PORT | 8585 | Port the server listens at |
|
|
|
|
|
| REGISTRATION_ENABLED | false | Whether to allow registration (applies to both WebApp & KOSync API) |
|
|
|
|
|
|
|
|
|
|
# Client (KOReader Plugin)
|
|
|
|
|
|
|
|
|
|
See documentation in the `client` subfolder: [SyncNinja](https://gitea.va.reichard.io/evan/BookManager/src/branch/master/client/)
|
2023-09-18 23:57:18 +00:00
|
|
|
|
|
|
|
|
# Development
|
|
|
|
|
|
2023-09-19 23:29:55 +00:00
|
|
|
SQLC Generation (v1.21.0):
|
2023-09-18 23:57:18 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
|
|
|
|
|
~/go/bin/sqlc generate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Run Development:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
CONFIG_PATH=./data DATA_PATH=./data go run cmd/main.go serve
|
|
|
|
|
```
|
|
|
|
|
|
2023-09-19 23:29:55 +00:00
|
|
|
# Building
|
|
|
|
|
|
|
|
|
|
The `Dockerfile` and `Makefile` contain the build information:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
# Build Local Docker Image
|
|
|
|
|
make docker_build_local
|
|
|
|
|
|
|
|
|
|
# Push Latest
|
|
|
|
|
make docker_build_release_latest
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
If manually building, you must enable CGO:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
# Download Dependencies
|
|
|
|
|
go mod download
|
|
|
|
|
|
|
|
|
|
# Compile (Binary `./bookmanager`)
|
|
|
|
|
CGO_ENABLED=1 CGO_CFLAGS="-D_LARGEFILE64_SOURCE" go build -o /bookmanager cmd/main.go
|
|
|
|
|
```
|
|
|
|
|
|
2023-09-18 23:57:18 +00:00
|
|
|
## Notes
|
|
|
|
|
|
|
|
|
|
- Icons: https://www.svgrepo.com/collection/solar-bold-icons
|
