create-startercraft

A CLI tool to quickly scaffold a new project from the latest release of the Startercraft template.

Features

• Downloads the latest release of the Startercraft template from GitHub
• Extracts and prepares the project in a new directory
• Automatically replaces the project name in package.json and package-lock.json
• Installs all dependencies automatically
• Ready to use with a single command

Installation

You can use it directly with npx (no need to install globally):

npx create-startercraft my-app

Or install globally:

npm install -g create-startercraft
create-startercraft my-app

Usage

npx create-startercraft <project-name>

• <project-name>: The name of the folder and project to be created.

Example:

npx create-startercraft awesome-app

This will:

• Download the latest Startercraft release
• Extract it to a new folder called awesome-app
• Replace the project name in package.json and package-lock.json
• Install all dependencies automatically

After creation

Navigate to your new project folder and start the development server:

cd awesome-app
npm start

Requirements

• Node.js >= 16
• npm >= 7

Troubleshooting

• If you see an error about the folder already existing, choose a different project name or remove the existing folder.
• If npm install fails, check your internet connection and Node.js/npm versions.

License

MIT

Repository

https://github.com/luciancaetano/create-startercraft