BrickTracker/README.md

33 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2024-12-26 20:27:17 +01:00
# BrickTracker
2024-02-28 19:58:47 +01:00
2024-12-26 17:51:33 +01:00
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.
2024-06-18 16:46:34 +02:00
2024-12-28 09:06:22 +01:00
<a href="https://www.buymeacoffee.com/frederikb" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174"></a>
2024-12-26 17:51:33 +01:00
## Features
2024-06-18 16:46:34 +02:00
2024-12-26 17:51:33 +01:00
- Track multiple LEGO sets with their parts and minifigures
- Mark sets as checked/collected
- Mark minifigures as collected for a set
2024-12-26 17:51:33 +01:00
- Track missing pieces
- View parts inventory across sets
- View minifigures across sets
2024-12-26 20:55:40 +01:00
- Wishlist to keep track of what to buy
2024-06-18 16:46:34 +02:00
## Prefered setup: pre-build docker image
2024-12-27 09:20:29 +01:00
Use the provided [compose.yaml](compose.yaml) file.
See [setup](docs/setup.md).
2024-12-27 09:20:29 +01:00
2024-12-26 17:51:33 +01:00
## Usage
See [first steps](docs/first-steps.md).
## Documentation
Most of the pages should be self explanatory to use.
However, you can find more specific documentation in the [docs](docs/) folder.
2024-12-28 09:06:22 +01:00
You can find screenshots of the application in the [bricktracker](docs/bricktracker.md) documentation file.