crafter-station/petdex: README-based editorial guide
A guide grounded in the README, repository metadata, and license for installing and checking crafter-station/petdex.
Project scope
crafter-station/petdex describes itself in the README as "The public gallery of animated pet for Codex, Claude Code, OpenCode y Gemini CLI". This article keeps to facts that can be checked in the repository. Stars, forks, and promotional badges are signals of attention, not proof of quality. Under "README", the README says: The public gallery of animated companions for Codex. Browse, install, and submit pets with one command.. That establishes the project's stated boundary, not a production test.
Suitable use cases
The README's "For builders" section gives a useful starting point for deciding whether the project fits: The pet package format. Every pet is a pet.json plus a spritesheet.{webp,png} rendered as an 8×9 grid of 192×208 frames.. If that problem is not yours, popularity is a poor reason to adopt it. Project names, commands, and component names are kept as written so a reader can return to the primary source without guessing at terminology. Another checkable README item is: The HTTP API. petdex.dev/api/manifest returns every approved pet with its slug, spritesheet URL, animation states, and metadata.. It can shape a first test, but it does not replace testing in the intended environment.
How it works
The operating model is spread across sections such as "What is Petdex". The source evidence includes: Every pet is a folder. Every folder is a Pokédex entry. Every entry is one npx petdex install away.. This article does not turn missing architecture, performance, or security details into claims. A real deployment still needs a look at the repository layout, configuration files, and release history.
Installation and first run
Start installation from the README's documented entry point. A command that can be checked in the source is: crafter-station/petdex ├── src/ │ ├── app/[locale]/ Public site: gallery, /pets/<slug>, /collections, /built-with, /community, /create, /download, /submit, /u/<handle>, ... │ ├── app/api/cli/ CLI endpoints: OAuth config, submit (zip → presigned R2), dedup check, register │ ├── app/api/manifest/ Public manifest: every approved pet with its spritesheet URL │ ├── app/api/admin/ Admin review surface for submissions, edits, collection requests │ └── lib/db/sc When the README contains no runnable command, this article does not invent one. Open its "Quick start" section and confirm system dependencies, default ports, and first-run initialization before using a public server.