mn-scaffold

Scaffold Midnight blockchain projects from a curated template registry — interactively, in seconds.

Usage

npx mn-scaffold

The CLI walks you through four steps:

1. Category — pick a domain (Basics, DeFi, ZK & Privacy, etc.)
2. Difficulty — filter by Beginner, Intermediate, or Advanced
3. Template — choose from available templates with descriptions
4. Project name — defaults to the template slug

Your project is scaffolded locally and ready to build.

Templates

Templates are fetched live from the Midnight Club registry. Current offerings:

Basics

| Template | Difficulty | |---|---| | Hello World | Beginner | | Counter | Beginner | | Calculator | Beginner |

State & Storage

| Template | Difficulty | |---|---| | Todo | Beginner | | Bulletin Board | Beginner |

Governance & Finance

| Template | Difficulty | |---|---| | Escrow | Intermediate | | Voting | Intermediate | | Quadratic Voting | Intermediate |

DeFi Primitives

| Template | Difficulty | |---|---| | Token Transfers | Intermediate | | Bonding Curve | Intermediate |

ZK & Privacy

| Template | Difficulty | |---|---| | ZK Allowlist | Advanced | | Battleship | Advanced |

All templates are Compact smart contracts targeting the Midnight testnet.

How it works

Templates live in tusharpamnani/midnight-programs-list as subdirectories in a monorepo. The CLI fetches metadata from templates.json hosted on Midnight Club, then uses degit to scaffold only the chosen subdirectory — no full repo clone, no extra history.

Contributing a template

1. Add your template as a subdirectory in midnight-programs-list following the existing structure
2. Add an entry to templates.json in the Midnight Club repo:

{
  "id": "your-template-id",
  "title": "Your Template",
  "description": "One sentence describing what it demonstrates.",
  "category": "ZK & Privacy",
  "difficulty": "advanced",
  "repo": "tusharpamnani/midnight-programs-list",
  "subdir": "compact-your-template",
  "branch": "main",
  "link": "https://github.com/tusharpamnani/midnight-programs-list/tree/main/compact-your-template"
}

3. Open a PR — once merged, the template is live in the CLI immediately.

Built with

• prompts — interactive CLI prompts
• degit — fast template scaffolding
• kleur — terminal colors

License

MIT