haveyouread

A personal, self-hosted application to track your reading progress, manage your book collection, and keep a record of books you've read. It works seamlessly on PC and mobile devices.

Demo

Spin up a demo container to test the project. This is not intended to be actively used, because security parameters are prefilled. For actually using haveyouread look at Deployment.

wget https://github.com/RatzzFatzz/haveyouread/blob/master/docker-compose-demo.yml
docker compose -f docker-compose-demo.yml up -d

Deployment

Setup

Choose one of the following environment configurations

1. H2 / database file

This configuration only needs the container for the application itself. For persistence the database file needs to be mounted, as outlined in the referenced docker-compose.yml

wget https://github.com/RatzzFatzz/haveyouread/blob/master/docker-compose-h2.yml
mv docker-compose-h2.yml docker-compose.yml

2. PostgreSQL / database server

This configuration utilises a separate database server and will also create a PostgreSQL container.

wget https://github.com/RatzzFatzz/haveyouread/blob/master/docker-compose-postgresql.yml
mv docker-compose-postgresql.yml docker-compose.yml

Deploy

docker compose up -d

Build from source

Requirements

• Java 21
• Maven
• (Optional) Docker installation

Build

maven clean install

Optionally build docker image

docker build --file dockerfile --tag haveyouread