module-scaffold

Generate a complete module skeleton under src/modules with entities, API routes, and configuration stubs.

Updated Mar 17, 2026
One-click install
npx skills add https://github.com/comerito/om-hackathon-starter --skill module-scaffold-comerito
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: module-scaffold
Source: https://github.com/comerito/om-hackathon-starter/tree/main/.ai/skills/module-scaffold
Command: npx skills add https://github.com/comerito/om-hackathon-starter --skill module-scaffold-comerito

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scaffold developers with a complete module skeleton, eliminating repetitive boilerplate and ensuring consistent project structure across modules.

Core Features & Use Cases

  • Auto-generates a complete module skeleton under src/modules/<module_id>/ with standard files and folders
  • Wires the module into the app with routing, DI, ACL, and events stubs
  • Creates a parallel structure for entities, API routes, validators, and backend UI pages
  • Use Case: when starting a new module like tickets or inventory, run the scaffold to bootstrap codebase quickly.

Quick Start

Create a new module using the scaffold to generate the standard module layout and integration points.

Frequently Asked Questions about module-scaffold

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a backend module skeleton with API routes and ACL?

To generate a backend module skeleton with API routes and ACL, use a scaffolding tool to auto-create the src/modules/<module_id>/ structure. This wires entities, validators, routing, DI, and events stubs to enforce consistent project conventions.

What is the best way to bootstrap a new TypeScript module with CRUD operations?

The best way to bootstrap a new TypeScript module with CRUD is to scaffold a complete module skeleton. This automates boilerplate creation, generating parallel structures for entities, API routes, validators, and backend pages quickly.

How does module scaffolding enforce naming and indexing conventions?

Module scaffolding enforces naming and indexing conventions by generating standard files and folders under a specific src/modules path. It auto-wires backend pages and configuration stubs to ensure consistent project structure across modules.

Can I automatically wire API routes and events when creating a new module?

Yes, you can automatically wire API routes and events when creating a new module. The scaffolding process generates integration points for routing, DI, ACL, and events stubs alongside the core entity and validator files.

Do I need to manually configure dependency injection when adding a new module?

No, you do not need to manually configure dependency injection when adding a new module. The scaffold automatically generates DI stubs and wires the module into the app, eliminating repetitive boilerplate setup.

When should I avoid using a module generator for my backend project?

You should avoid using a module generator if your backend project requires a highly custom folder structure that deviates from standard src/modules conventions, as the scaffold enforces specific naming and indexing patterns.