BrickTracker/README.md

5.3 KiB

BrickTracker

A web application for organizing and tracking LEGO sets, parts, and minifigures. Uses the Rebrickable API to fetch LEGO data and allows users to track missing pieces and collection status.

Features

  • Track multiple LEGO sets with their parts and minifigures
  • Mark sets as checked/collected
  • Track missing pieces
  • View parts inventory across sets
  • View minifigures across sets
  • Automatic updates for LEGO data (themes, colors, sets)

Screenshots

  • Front page: Search your inventory and sort by theme, year, parts, id, name or sort by missing pieces. If you download instructions as PDF, add them to a specific folder and they show up under each set

  • Inventory page: Filter by color, quantity, name. Add if a piece is missing. Press images to show them. Filter by only missing pieces. Minifigures and their parts are listed at the end.

  • Missing pieces: List of all your missing pieces, with links to bricklink and rebrickable.

  • All parts: List of all parts in inventory again with links to bricklink and rebrickable.

  • Minifigures: List of all minifigures in inventory and quantity.

  • Multiple sets: Each set is given a unique ID, such that you can have multiple copies of a set with different pieces missing in each copy. Sets can also easily be deleted from the inventory.

  • Add set: Sets are added from rebrickable using your own API key. Set numbers are checked against sets.csv from rebrickable and can be updated from the config page. When a set is added, all images from rebrickable are downloaded and stored locally, so if multiple sets contains the same part/color, only one image is downloaded and stored. This also make no calls to rebrickable when just browsing and using the site. Only time rebrickable to used it when up adding a new set.

  • Wishlist: Sets are added from rebrickable and again checked against sets.csv. If you can't add a brand new set, consider updating your data from the /config page. Press the delete button to remove a set. Known Issue: If multiple sets of the same number is added, they will all be deleted.

Prerequisites

  • Docker
  • Docker Compose
  • Rebrickable API key (from Rebrickable)

Setup

  1. Clone the repository:
git clone https://gitea.baerentsen.space/FrederikBaerentsen/BrickTracker.git
cd BrickTracker
mkdir static/{sets,instructions,parts}
  1. Create a .env file with your configuration:
REBRICKABLE_API_KEY=your_api_key_here
DOMAIN_NAME=https://your.domain.com

If using locally, set DOMAIN_NAME to http://localhost:3333.

  1. Deploy with Docker Compose:
docker compose up -d
  1. Access the web interface at http://localhost:3333

  2. The database is created, csv files are downloaded and you will be redirected to the /create page for inputting a set number.

Usage

Adding Sets

  1. Go to the Create page
  2. Enter a LEGO set number (e.g., "42115")
  3. Wait for the set to be downloaded and processed

Managing Sets

  • Mark sets as checked/collected using the checkboxes
  • Track missing pieces by entering quantities in the parts table
    • Note, the checkbox for missing pieces is updated automatically, if the set has missing pieces. It cannot be manually checked off.
  • View all missing pieces across sets in the Missing page
  • View complete parts inventory in the Parts page
  • View all minifigures in the Minifigures page

Docker Configuration

The application uses two main configuration files:

docker-compose.yml

services:
  bricktracker:
    container_name: BrickTracker
    restart: unless-stopped
    build: .
    ports:
      - "3333:3333"
    volumes:
      - .:/app
    env_file:
      - .env

Dockerfile

FROM python:slim
WORKDIR /app
COPY requirements.txt .
RUN pip install -r requirements.txt
COPY . .
RUN bash lego.sh
CMD ["gunicorn","--bind","0.0.0.0:3333","app:app","--worker-class","eventlet"]

Development

The application is built with:

  • Flask (Python web framework)
  • SQLite (Database)
  • Socket.IO (Real-time updates)
  • Rebrickable API (LEGO data)

Key files:

  • app.py: Main application code
  • db.py: Database operations
  • downloadRB.py: Rebrickable data download utilities

Notes

  • The application stores images locally in the static directory
  • Database is stored in app.db (SQLite)
  • LEGO data is cached in CSV files from Rebrickable
  • Images are downloaded from Rebrickable when entering a set and then stored locally.