create-mkstack

create-mkstack

A simple utility to create a new project based on the mkstack template.

Usage

You can run it directly with npx:

# Interactive mode (prompts for directory name)
npm create mkstack
# or
npx create-mkstack

# Non-interactive mode (specify directory name as an argument)
npm create mkstack my-project
# or
npx create-mkstack my-project

# Non-interactive mode with automatic overwrite
npm create mkstack my-project -y
# or
npx create-mkstack my-project --yes

What it does

This utility:

• Downloads and extracts the mkstack template (from https://gitlab.com/soapbox-pub/mkstack/-/archive/main/mkstack.tar) without requiring git to be installed
• Initializes a new git repository inside the project (if git is available)
• Creates an initial commit with all the template files (if git is available)

Options

You can use the following options:

• Directory Name - Provide the project directory as a command line argument:

  npx create-mkstack my-project
  

• -y or --yes Flag - Skip confirmation when overwriting an existing directory:

  # Skip confirmation for directory overwrite
  npx create-mkstack my-project -y
  # or
  npx create-mkstack my-project --yes
  

If no directory argument is provided, you'll be prompted for:

• Project directory name: The name of the directory where the project will be created

Requirements

Node.js 14.0.0 or newer

Git is optional - the utility will initialize a git repository if git is available on your system, but will work without it.

License

MIT