📚 BookLibrary

BookLibrary is a library for book notes. In fact, BookNoteLibrary would be a more appropriate name since the idea is to manage book notes -- not whole books.

🐳 Installation (in three simple steps via Docker)

1. Download the docker-compose.yml file or clone the whole repository:

git clone git@github.com:Malte311/BookLibrary.git

2. Adjust the docker-compose.yml file. Specify the correct url and adjust the port.

version: "2"

services:
  web:
    image: quay.io/malte311/book-library:latest
    container_name: book-library
    ports:
      - "127.0.0.1:8080:80"
    volumes:
      - ./data/:/php-code/data/
    restart: always
    environment:
      - SERVERURL=https://example.com/book-library

3. Get the newest Docker image and start a Docker container (inside of the project folder):

docker-compose pull
docker-compose up -d

📖 Usage

After the installation, run php userAdministration.php add on the command line in order to create an initial user. Afterwards, you can log into the application using the credentials you just created. This script allows you to delete, edit or list all available users as well. Simply replace the parameter add with delete, edit or list, respectively.

While logged in, you can view, filter and sort all book note files which are present in the data/ directory. In order to get rid of the example files from this repository, simply delete them in the data/ folder. For adding new book notes, place their corresponding markdown files in the data/books/ folder (and optionally the book cover in the data/covers/ folder). A detailed guide on how to manage the book note files can be found here.

The content of each book note file can be viewed by clicking on the corresponding card in the overview.

📄 License

This project is licensed under the terms of the MIT License.