Josh Creek
de39dc78ea
Splits testing into five layers so a failure points at the responsible one: - tests/unit isolated utility, repository and service tests - tests/data validates the tracked Pokémon, game, region and dex files - tests/integration schema, views, constraints, RLS and repositories - tests/bdd executable Gherkin for user-visible behaviour - tests/build service worker and manifest artifacts per build variant Replaces the two Playwright specs in client-test/ and the two Vitest files in test/. Adds a GitHub Actions workflow running the layers as separate jobs, a mock OAuth provider server so the Drive and Dropbox scenarios never touch real accounts, and a wrapper that reads the local Supabase keys from `supabase status` rather than hard-coding them. Extracts the pure formatting helpers out of PokedexExportService so they can be unit tested, and makes the provider endpoints configurable so the mock server can stand in for Google and Dropbox.
Living Dex Tracker
A web app to track completion of a living Pokédex.
Developing
-
Clone the repository
-
Install the dependencies with
npm install -
Ensure that Docker is running
-
An example
.envfile is provided in the repository. You will need to copy.env.exampleto.envand fill in the values with your own credentials. For local development with Supabase running in Docker, you can use the following values:- The
PUBLIC_SUPABASE_URLwill be"http://127.0.0.1:54321" - The
PUBLIC_SUPABASE_ANON_KEYwill be the 'Publishable' authentication key displayed when you run Supabase in the terminal - The
SUPABASE_SERVICE_ROLE_KEYwill be the 'Secret' authentication key displayed when you run Supabase in the terminal
- The
-
Start local Supabase and a development server with
npm run dev:supabase -
The Pokédex data is automatically seeded via database migrations when Supabase starts
-
Create an account using the sign-up form and access the email it sends in MailPit to verify your email address. N.B. All local emails are captured by MailPit when running Supabase in Docker.
-
You can now use the app.
Reference Data Updates
The seed data lives in supabase/migrations/20260118001000_seed_reference_data.sql. Update that migration directly when new data is added. You can access a local copy of Supabase to check it.
Building
To create a production version:
npm run build
Testing
The test suite is split by responsibility so a failure points to the correct layer:
tests/unitcontains fast, isolated tests for utilities, repositories, and services.tests/datavalidates the tracked Pokémon, game, region, dex, and sprite reference files.tests/integrationchecks the migrated Supabase schema, views, constraints, RLS, and repositories.tests/bdd/featuresis the executable Gherkin specification for user-visible behaviour. Step definitions and browser fixtures live beside it undertests/bdd.tests/buildverifies generated service-worker and manifest artifacts after each supported build.
Run the offline suites while developing:
npm run test:fast
npm run test:coverage
Database and BDD tests require Docker and the local Supabase stack. The wrappers read local keys from
supabase status; no credentials are written to disk or committed:
npm run supabase:start
npm run supabase:reset
npm run test:integration
npm run test:bdd
npm test runs the complete CI-equivalent sequence and fails with setup instructions when Supabase is
not available. Individual layers are available as test:unit, test:data, test:integration,
test:build, and test:bdd.
Gherkin describes outcomes in domain language. Keep selectors, API calls, test-user provisioning, and
provider mocks in step definitions or support fixtures. @product-review marks a rule that should be
reviewed with product stakeholders, but does not skip it. Missing or ambiguous steps fail generation.
Google Drive and Dropbox scenarios use a local provider server and private endpoint overrides. They do
not contact real provider accounts. Chromium is the only configured browser project. Playwright traces
and screenshots are retained on failure under test-results.
The current National Dex maximum is deliberately asserted as 1025. When adding a new generation, update that expectation together with Pokémon data, the corresponding game/dex files, database seed, and sprites. Data tests print the exact conflicting identities or broken references.
You can preview the production build with npm run preview.
Sprites
The app uses WebP sprites from static/sprites-small. During builds we generate this folder from the
full-resolution PNGs in static/sprites:
npm run sprites:build
If you want to serve sprites locally, set PUBLIC_USE_LOCAL_POKEMON_SPRITE_FOLDER="true" in .env.
Otherwise the app defaults to GitHub raw for static/sprites-small.
Hosting
The app is hosted on Netlify at pokedex.jcreek.co.uk.
The Pokédex data is stored in a Supabase database.
User authentication is handled by Supabase Auth.
Dependencies
The living dex tracker's sprite collection is derived from PokéAPI Sprites
and converted to smaller WebP files in static/sprites-small. PokéAPI sprites are licensed under
the Creative Commons CC0 1.0 Universal license.