Run locally

Install

Use Python 3.11+ and uv. The reference Pokedex JSON is already shipped, so the UI starts without scraping first.

1. Local server

Recommended for development and everyday use.

git clone https://github.com/Boblebol/pokevault.git
cd pokevault
make install
make dev

2. Docker

Build and run the tracker container on localhost.

make docker-build
make docker-up
make docker-logs

Data files

Readable JSON, versionable if you want it.

PathPurpose
data/pokedex.jsonTracked reference Pokedex shipped with the repository.
data/narrative-tags.jsonTracked narrative tag definitions.
data/game-pokedexes.jsonTracked game Pokedex definitions and appearances.
data/collection-progress.jsonLocal user progress and badge unlocks.
data/binder-*.jsonLocal binder configuration and placements.

Useful commands

Scrape, test and export.

Fast scrape

make fetch-test scrapes 10 entries without images.

Full scrape

make fetch refreshes the Pokedex and sprite images.

Quality gate

make check runs lint and tracker coverage.