Giter Club home page Giter Club logo

bookshelf's Introduction

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 Github

  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/Bookshelf-fatJar.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

bookshelf's People

Contributors

buried-in-code avatar dependabot[bot] avatar

Watchers

 avatar

bookshelf's Issues

Search for Book to add

Expand the import from just isbn/openlibrary id to include search by title, author, etc...

Change Author to Creator

To allow for other roles in books, replace the Author field with Creator.

  • Rename Author > Creator
  • Add field for Creator Roles

Str to int error

If there is a space in the isbn entry field when converted to int for the check digit it raises a 500

Split Series field

Series currently only is a str, split the field into:

  1. Series title
  2. Series num (Optional)

Add "Read Next"

Add a list to the profile page that shows the next book in the series to read.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.