Submit a Template

Share it with the community by submitting it as a template.

How to Submit

Add to Examples Folder

Create your example in the examples/ folder of the Rivet repository.

Configure Template Block

Add a template block to your example's package.json:

{
  "name": "my-example",
  "license": "MIT",
  "template": {
    "technologies": ["typescript", "react"],
    "tags": ["starter"]
  },
  "scripts": {
    "dev": "...",
    "check-types": "tsc --noEmit"
  }
}

JSON

Build Example Registry

Run the following command to regenerate the template registry:

pnpm build -F @rivetkit/example-registry

Command Line

Create Pull Request

Submit your changes by creating a pull request to the Rivet repository.

Template Options

technologies (required) - Array of technologies used
tags (required) - Array of tags categorizing the template
noFrontend (optional) - Set to true to skip screenshot generation
priority (optional) - Lower numbers appear first in the list