documenting-blueprint

Use when documenting blueprints in create-faster MDX docs - covers pre-composed starter projects with composition, architecture, application code, CLI usage, and extra dependencies

Jump to install

Repository: plvo/create-faster
Last source activity: March 16, 2026 at 15:11
Detected SKILL.md language: English
Stars: 28
Forks: 1

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Back to search Back to installation

---
title: Blueprint Name
description: One-line description of the starter project (from META.blueprints[name].hint)
---

## Presentation

Brief description of the complete starter project (2-3 sentences). What does the user get?

## Composition

**Apps:**
- `appName` — Stack ([→ docs](/docs/stacks/stackname)) + modules ([→ module](/docs/modules/category/name), ...)

**Project addons:**
- Database: [→ PostgreSQL](/docs/database/postgresql)
- ORM: [→ Drizzle](/docs/orm/drizzle)
- Deployment: [→ SST](/docs/deployment/sst) (if applicable)

## Architecture

File tree of the blueprint-specific application code (only what the blueprint ADDS beyond structural templates):

\`\`\`
src/
├── app/
│   ├── page.tsx                # Description
│   └── (section)/
│       ├── layout.tsx          # Description
│       └── page.tsx            # Description
├── components/
│   └── component.tsx           # Description
└── lib/
    └── util.ts                 # Description
\`\`\`

For multi-app blueprints (turborepo), show per-app structure.

## What's included

Describe the key application features the blueprint provides. Keep it factual — what pages exist, what functionality they have. Use subsections if the blueprint has multiple significant features.

Code examples ONLY for blueprint-specific patterns (e.g., custom auth integration, special middleware). Do NOT show code for standard library setup — link to module docs instead.

## Extra dependencies

Only if `META.blueprints[name].packageJson` exists:

\`\`\`
package        version     purpose
recharts       ^2.15.0     Dashboard charts
\`\`\`

## Environment variables

Only if `META.blueprints[name].envs` exists:

- `VAR_NAME` - Purpose (scope: app/root/pkg)

## CLI usage

\`\`\`bash
bunx create-faster myproject --blueprint {name} --linter biome --git --pm bun
\`\`\`

# Check blueprint metadata in META
grep -A 40 "'{blueprintname}'" apps/cli/src/__meta__.ts

# Check composition: apps, stacks, libraries
grep -A 20 "context:" apps/cli/src/__meta__.ts | grep -A 15 "'{blueprintname}'"

# Check extra dependencies
grep -A 10 "packageJson:" apps/cli/src/__meta__.ts | grep -A 8 "'{blueprintname}'"

# Check extra env vars
grep -A 10 "envs:" apps/cli/src/__meta__.ts | grep -A 8 "'{blueprintname}'"

# List all blueprint template files
find apps/cli/templates/blueprints/{blueprintname}/ -name "*.hbs" | sort

# Check for frontmatter (path/scope overrides)
grep -l '^---' apps/cli/templates/blueprints/{blueprintname}/**/*.hbs

# Check for stack-specific templates
ls apps/cli/templates/blueprints/{blueprintname}/**/*.*.hbs

# Check for mono/single filtering
grep 'only:' apps/cli/templates/blueprints/{blueprintname}/**/*.hbs

# Verify composition matches META
grep -A 30 "'{blueprintname}'" apps/cli/src/__meta__.ts

# Verify template files exist
find apps/cli/templates/blueprints/{blueprintname}/ -name "*.hbs" | sort

# Verify extra dependencies are in blueprint META (not composition META)
grep -A 10 "packageJson:" apps/cli/src/__meta__.ts | grep -A 8 "'{blueprintname}'"

# Verify extra envs are in blueprint META (not composition META)
grep -A 10 "envs:" apps/cli/src/__meta__.ts | grep -A 8 "'{blueprintname}'"

# Verify apps in composition
grep -A 15 "context:" apps/cli/src/__meta__.ts | grep -A 10 "'{blueprintname}'"

content/docs/blueprints/
├── meta.json              # Root folder config listing categories
├── business/
│   ├── meta.json          # { "title": "Business" }
│   └── dashboard.mdx
├── web3/
│   ├── meta.json          # { "title": "Web3" }
│   ├── dapp-privy.mdx
│   └── dapp-rainbowkit.mdx
└── aws/
    ├── meta.json          # { "title": "AWS" }
    ├── lambda-sst.mdx
    └── lambda-terraform-aws.mdx

{
  "title": "Blueprints",
  "pages": ["business", "web3", "aws"]
}

"---BLUEPRINTS---",
"...blueprints"

Mistake	Fix
Explaining library features	Link to module docs, focus on blueprint application code
Listing composition deps as extras	Only `META.blueprints[name].packageJson` goes in extra deps
Listing composition envs as extras	Only `META.blueprints[name].envs` goes in extra env vars
Missing composition section	REQUIRED: list all stacks, libraries, project addons with links
No file tree	Show blueprint-specific files with tree structure
Documenting structural templates	Only document what the BLUEPRINT adds/overrides
Missing CLI usage	Show `--blueprint {name}` example command
Unverified template files	Check `apps/cli/templates/blueprints/{name}/`
Missing multi-app architecture	Turborepo blueprints need per-app structure

Excuse	Reality
"Need to explain what shadcn does"	Module docs exist. Link to them.
"Should show tRPC setup"	Module docs cover that. Blueprint docs cover application code.
"All dependencies should be listed"	Only blueprint-specific extras. Composition deps are in their own META entries.
"Should explain how better-auth works"	Link to `/docs/modules/auth/better-auth`. Focus on blueprint-specific auth patterns.
"The file tree should show everything"	Only blueprint-specific files. Structural templates are documented elsewhere.
"I saw this dependency in the generated output"	Verify it's in `META.blueprints[name].packageJson`, not coming from composition.
"Users need the full picture"	Composition links + blueprint specifics IS the full picture. Don't duplicate.