Create a template and catalog listing
Prepare a runnable example, hosted demo and metadata for the maintained catalog.
On this page
Make the project stand on its own
Use a clean copy with sample data. Document its purpose, setup commands, required services and supported runtime. Test from a fresh folder and on a phone. Include a license and an explanation of what the user can change.
Remove credentials, personal data, internal addresses, generated caches and private screenshots. A template should not depend on the author’s machine or accounts.
Write a useful listing
Describe the outcome, who it helps and its limitations. Listings are hosted templates,
so every entry names a static demo on lyrestudio.github.io that readers can
test inside the app. The catalog accepts these fields:
{
"id": "opening-checklist",
"title": "Opening checklist",
"summary": "A small checklist for a team’s opening routine.",
"category": "Operations",
"status": "listed",
"kind": "template",
"features": ["Check off tasks", "Use sample data"],
"previewUrl": "https://lyrestudio.github.io/opening-checklist/",
"repositoryUrl": "https://github.com/LyreStudio/opening-checklist",
"license": "MIT"
}
kind, previewUrl and license are required;
repositoryUrl, imageUrl and setupUrl are optional
and must point at reviewed sources. This is a listing example, not an installation
package. It does not publish anything. The catalog accepts up to 50 offerings; titles
are limited to 80 characters, summaries to 280, and one to six feature descriptions to
120 characters each.
Prepare the review material
Include screenshots of the actual project with fictional data, a versioned source location, setup instructions and a test checklist. Record dependencies and external data use. Don’t claim native features based only on a web preview.
The maintained catalog
Catalog entries use the trusted catalog-maintenance process. The metadata example documents its input; it does not upload files or publish a listing. Keep a reviewed source revision, demo and license together for the catalog owner.
Never put a server publishing key into a listing or client app.