@yvnbunag/scaffold

CLI tool to quickly generate project from boilerplate

Contents

• Requirements
• Installation
  • With pnpm
  • With yarn
  • With npm
• Templates
• Usage
• Contributing

Requirements

1. Node.js version 16.11.1 or higher
2. pnpm version 6.11.0 or higher
   • May be swapped with other package managers such as npm and yarn

Installation

With pnpm

pnpm add --global @yvnbunag/scaffold

With yarn

yarn global add @yvnbunag/scaffold

With npm

npm install -g @yvnbunag/scaffold

Templates

Listed are the currently available templates

• Coding challenge
  • JET (Jest, ESLint and TypeScript)
• Microservice (Back End)
  • Fastify
    • JET (Jest, ESLint and TypeScript)
  • NestJS
    • TVT (TypeORM, Vitest and TypeScript)
• Web (Front End)
  • Next.js
    • MTC (Material UI, TypeScript and Cypress)

Usage

1. Run scaffold command

scaffold

2. Select template

3. Provide project name, which would be the directory name

4. Provide template replacements if prompted

5. Navigate to scaffolded project

cd <project-name>

6. Preview scaffold README.md for setup instructions

Contributing

See Contributing