crafter-station/petdex: Redaktioneller README-Leitfaden
Ein auf README, Metadaten und Lizenz gestützter Leitfaden für crafter-station/petdex.
Projektumfang
crafter-station/petdex beschreibt sich im README als „The public gallery of animated pet for Codex, Claude Code, OpenCode y Gemini CLI". Dieser Text bleibt bei Fakten, die im Repository überprüfbar sind. Sterne, Forks und Badges zeigen Aufmerksamkeit, aber keine Qualität. Unter „README" steht: The public gallery of animated companions for Codex. Browse, install, and submit pets with one command.. Das beschreibt den vorgesehenen Umfang, nicht einen Produktionstest.
Geeignete Einsatzfälle
Der Abschnitt „For builders" zeigt, für welches Problem das Projekt gedacht ist: 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.. Passt dieses Problem nicht zu deinem Fall, ist Popularität kein ausreichender Grund. Namen, Befehle und Komponenten bleiben unverändert, damit Leser die Primärquelle ohne neue Begriffe vergleichen können. Ein weiterer überprüfbarer README-Punkt lautet: The HTTP API. petdex.dev/api/manifest returns every approved pet with its slug, spritesheet URL, animation states, and metadata.. Er hilft beim ersten Test, ersetzt aber keinen Test in der vorgesehenen Umgebung.
Funktionsweise
Die Betriebsweise verteilt sich auf Abschnitte wie „What is Petdex". Die Quelle nennt: Every pet is a folder. Every folder is a Pokédex entry. Every entry is one npx petdex install away.. Fehlende Angaben zu Architektur, Leistung oder Sicherheit werden nicht ergänzt. Vor einem echten Einsatz müssen Repository-Struktur, Konfigurationsdateien und Release-Verlauf geprüft werden.
Installation und erster Start
Beginne die Installation am dokumentierten README-Einstieg. Ein überprüfbarer Befehl ist: 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 Wenn kein ausführbarer Befehl vorhanden ist, wird hier keiner erfunden. Prüfe den Abschnitt „Quick start" auf Abhängigkeiten, Standardports und die Einrichtung beim ersten Start.