Documentation

Comprehensive guide to using create-awesome-node-app

Introduction to create-awesome-node-app

create-awesome-node-app is a powerful command-line tool designed to streamline the process of setting up modern Node.js applications. It provides a collection of carefully crafted templates and extensions that help developers quickly bootstrap projects with best practices and optimal configurations.

Key Benefits

  • Rapid Setup

    Bootstrap projects in seconds with a single command

  • Curated Templates

    Choose from a variety of specialized project templates

  • Modular Extensions

    Add only the features you need with optional extensions

  • Customizable

    Tailor templates to your specific requirements

Getting Started

Using create-awesome-node-app is straightforward. You can create a new project with a single command:

npx create-awesome-node-app my-app

This will launch an interactive CLI that guides you through selecting a template and optional extensions for your project.

Prerequisites

Before using create-awesome-node-app, ensure you have the following installed:

  • Node.js (version 18.0.0 or higher)
  • npm, Yarn, or pnpm package manager

Command Options

The CLI supports several options to customize your project creation:

OptionDescription
-V, --versionOutput the version number
-v, --verbosePrint additional logs
-i, --infoPrint environment debug info
--no-installGenerate package.json without installing dependencies
-t, --template <template>Specify a template for the created project
--addons [extensions...]Specify extensions to apply for the boilerplate generation
--use-yarnUse yarn instead of npm or pnpm
--use-pnpmUse pnpm instead of yarn or npm
--interactiveRun in interactive mode to select options (default: false)
--list-templatesList all available templates
--list-addonsList all available addons
-h, --helpDisplay help for command

Examples

Create a project with interactive mode:

npx create-awesome-node-app my-app --interactive

Create a project with a specific template:

npx create-awesome-node-app my-app --template react-vite-boilerplate

Create a project with a template and extensions:

npx create-awesome-node-app my-app --template react-vite-boilerplate --addons material-ui github-setup

List all available templates:

npx create-awesome-node-app --list-templates

List all available extensions:

npx create-awesome-node-app --list-addons

Available Templates

create-awesome-node-app offers a variety of templates for different types of applications:

React Vite Boilerplate
A fast and lightweight React boilerplate with Vite

Includes TypeScript, React Router, and modern tooling for frontend development.

NestJS Boilerplate
A scalable backend application with NestJS

Includes TypeScript, ESLint, and Prettier for building maintainable backend services.

NextJS Starter
A production-ready Next.js starter

Includes TypeScript, ESLint, and Prettier for rapid full-stack development.

Turborepo Boilerplate
A modern monorepo boilerplate

Includes Turborepo, TypeScript, Changesets, and Workspaces for efficient multi-package management.

Web Extension React
A boilerplate for building WebExtensions

Includes React, Vite, TypeScript, and features like hot module replacement.

WebdriverIO Boilerplate
A comprehensive testing boilerplate

Includes WebdriverIO, TypeScript, and Selenoid for automated user acceptance testing.

Documentation Sections

Templates
Learn about available templates and how to use them
Extensions
Discover extensions to enhance your projects
Contributing
Learn how to contribute templates and extensions
Advanced Usage
Explore advanced features and configurations