create-scaffold-kit

Scaffold opinionated React (Vite) or Next.js applications with best practices baked in.

Table of Contents

• Features
• Quick Start
• What You Get
• Requirements
• Development & Testing
• Documentation
• Contributing
• License

Features

Frameworks: React (Vite), Next.js (App Router)

Development: TypeScript, ESLint (strict/standard), Prettier, Husky + lint-staged

Testing: Vitest with React Testing Library, coverage reporting

Styling: Tailwind CSS (optional)

DevOps: Docker, GitHub Actions CI/CD

Quick Start

npx create-scaffold-kit my-app
cd my-app

# then install and start with your package manager
npm install && npm run dev
# or: yarn install && yarn dev
# or: pnpm install && pnpm dev

For detailed usage, configuration options, and examples, see User Guide

What You Get

React (Vite): Lightning-fast HMR, feature-based structure, path aliases, strict TypeScript

Next.js: App Router with RSC, security headers, absolute imports, optimized builds

Development Tools: ESLint (flat config, import ordering), Prettier, Husky + lint-staged

Testing: Vitest, React Testing Library, coverage, interactive UI

CI/CD: GitHub Actions with multi-version testing, type checking, linting

Docker: Multi-stage builds, production-ready images

Requirements

• Node.js 18+
• npm, Yarn, or pnpm
• Git (optional)
• Docker (optional)

Development & Testing

Development Setup

# Install dependencies
yarn install

# Start development (watch mode)
yarn dev

# Type checking
yarn type-check

# Linting
yarn lint

# Formatting
yarn format

Testing

This project includes comprehensive unit tests using Vitest:

# Run all tests once
yarn test:run

# Run tests in watch mode
yarn test:watch

# View interactive test UI
yarn test:ui

# Generate coverage report
yarn test:coverage

Test Coverage:

• File utilities (100%)
• Package.json manipulation (100%)
• Logging system (95%)
• User prompts (85%+)
• Installation utilities (90%+)

For detailed testing information, see Testing Guide

Documentation

• User Guide - How to use create-scaffold-kit
• Developer Guide - Architecture and extending the CLI
• Testing Guide - Running and writing tests
• NPM Publishing - Publish to npm registry
• GitHub Publishing - Create GitHub releases

Contributing

See Contributing for development guidelines and setup.

License

MIT

Built for developers who refuse to compromise on clean code.