kienhoefr/drinklist repository overview

⁠Drinklist

Find sources here⁠

The Drinklist is essentially a digital tally sheet which is intended for tracking coffee or beverage self-service sales in offices or communities. It is intended to be used very quickly and with very minimal user interaction. This project also includes a management view to manage and track the inventory and the sales.

• Drinklist⁠
  • Prerequisites⁠
  • Install locally⁠
  • Run with Docker (recommended)⁠
  • Configuration⁠
    • user-settings.json⁠
    • config.json⁠
    • auth.json⁠
  • Upgrading⁠
  • Interfaces⁠

⁠Prerequisites

• npm
• sqlite3

⁠Install locally

First install all dependencies and build the typescript sources with:

npm install
npm build

Then start the node js server with:

npm start

or run it directly with:

node .
# OR
node dist/express/main.js

Now go to http://localhost:8080⁠ to start using Drinklist.

⁠Run with Docker (recommended)

Image: kienhoefr/drinklist

Start with mapped config dir and forwarded ports:

docker run -e TZ="Europe/Berlin" -p 8080:8080 -v ~/drinklistData:/app/data kienhoefr/drinklist

You can also run Drinklist using docker-compose:

services:
  drinklist:
    image: kienhoefr/drinklist
    # You may also use the GitHub registry:
    #image: ghcr.io/kienhoefr/drinklist
    container_name: drinklist
    restart: unless-stopped
    ports:
      # Change to your liking or don't expose the port when you use an internal reverse proxy
      - 8080:8080
    volumes:
      # Use local bind mount
      - ./data:/app/data
      # Alternatively use docker volume
      #- drinklist-data:/app/data
    environment:
      # Optionally set the containers timezone. As all dates are saved in UTC there is not real need.
      # HOWEVER, it is recommended to set the timezone when upgrading from 1.x, as Drinklist will automatically migrate the database.
      TZ: Europe/Berlin

# When using docker volume to store the data
#volumes:
#  drinklist-data:
#    name: drinklist-data

⁠Configuration

When first starting Drinklist, it will display a configuration page that can be used to configure Drinklist to your liking.

These settings are available:

⁠user-settings.json

⁠config.json

⁠auth.json

This file contains the passwords for the Drinklist users in plaintext for greater ease of use. In the future, Drinklist might change to hashing/salting the passwords.

⁠Upgrading

Updates prior to 2.0 need manual steps to be done when updating. Instructions for these can be found here⁠.

When updating to version 2.0, Drinklist will back up all you data files to a backup directory in your data folder, so you can roll back if anything goes wrong.

⁠Interfaces