shadyt-gen

CLI tool to scaffold Next.js and .NET project structures.

Installation

npm install -g shadyt-gen

Usage

Basic Command Structure

shadyt-gen <next|dotnet> [options]

Options (for both next and dotnet)

• -a, --all     Enable all features and use sensible defaults (no prompts)
• -p, --path <path>     Path to create/find the project directory (default: current directory)
• -n, --name <name>     Name of the project (used for folder creation or lookup)

Example: Scaffold a Next.js Project with All Features

shadyt-gen next -a -p C:\Projects -n MyNextApp

Example: Scaffold a .NET Project with All Features

shadyt-gen dotnet -a -p C:\Projects -n MyDotnetApp

Interactive Mode (Prompt for Each Option)

If you omit -a, shadyt-gen will prompt you for each feature:

shadyt-gen next -n MyNextApp
shadyt-gen dotnet -n MyDotnetApp

Help

shadyt-gen --help
shadyt-gen <next|dotnet> --help

Features & Generated Files

Next.js

• App directory structure (app/, components/, lib/, etc.)
• Optional: MDX, NextAuth, Prisma, Tailwind CSS
• Database setup (Postgres, with sensible defaults if -a is used)
• .env, config, and utility files

.NET

• Layered solution structure (Controllers, Models, Services, Data, etc.)
• General-use enums (StatusCode, UserRole)
• Response classes (BaseResponse, ErrorResponse, SuccessResponse, ItemResponse, ItemsResponse)
• IResponse interface
• Sample controllers (AIModelsController, AuthController, HealthController, VersionedController)
• Sample unit tests (Xunit)
• .editorconfig, .gitignore, Dockerfile, docker-compose.yml (if Docker enabled)
• Docs/Swagger/swagger.json (starter OpenAPI spec)
• .github/workflows/dotnet.yml (GitHub Actions CI)
• .prettierrc (for JS/TS formatting)

Customizing Swagger UI (for .NET projects)

A starter swagger.json is generated in Docs/Swagger/. You can:

• Edit this file to document your API endpoints.
• Use the Swagger Editor for a visual interface.
• In your .NET project, ensure Swagger is enabled (see Extensions/SwaggerServiceExtensions.cs).
• To customize the UI, edit the UseCustomSwagger method or add options in SwaggerServiceExtensions.cs.

For more, see: Swagger/OpenAPI docs.

Docker & Docker Compose

If Docker is enabled, a Dockerfile and docker-compose.yml are generated for API + Postgres orchestration.

GitHub Actions

A starter workflow is generated at .github/workflows/dotnet.yml for .NET CI/CD.

Release Process

A helper script is provided at scripts/release-helper.ps1 to:

• Show the current published NPM version and git tags
• Walk you through git add, commit, tag, push, and npm publish

Run in PowerShell:

pwsh scripts/release-helper.ps1

Contributing

1. Fork the repository
2. Create a feature branch
3. Submit a pull request

License

MIT