Skip to content

Tool for tracking books on your bookshelf or books you wish were on it.

License

Notifications You must be signed in to change notification settings

Buried-In-Code/Bookshelf

Repository files navigation

Bookshelf Logo

Bookshelf

Java Version Kotlin Version Status

Gradle Ktlint Javalin Bulma

Github - Version Github - License Github - Contributors

Tool for tracking books on your bookshelf or books you wish were on it.

Usage

via Jar

  1. Make sure you have a supported version of Java installed: java --version
  2. Clone the repo: git clone https://github.com/Buried-In-Code/Bookshelf
  3. Build using: ./gradlew build
  4. Run using: java -jar ./app/build/libs/app-0.4.1-all.jar

via Gradle

  1. Make sure you have a supported version of Java installed: java --version
  2. Clone the repo: git clone https://github.com/Buried-In-Code/Bookshelf
  3. Run using: ./gradlew build run

via Docker-Compose

  1. Make sure you have Docker installed: docker --version
  2. Make sure you have Docker-Compose installed: docker-compose --version
  3. Create a docker-compose.yaml file, an example:
version: '3'

services:
  bookshelf:
    image: 'ghcr.io/buried-in-code/bookshelf:latest'
    container_name: 'Bookshelf'
    environment:
      TZ: 'Pacific/Auckland'
    ports:
      - '25710:25710'
    volumes:
      - './config:/app/config'
      - './data:/app/data'
  1. Run using: docker-compose up -d

Socials

Social - Fosstodon
Social - Matrix