next-boil

next-boil is a CLI tool to bootstrap your Next.js starter pack with ease. Clone a pre-configured template, customize it with options, and start your Next.js journey in seconds.

Features

• Next.js 15
• Tailwind CSS 3
• shadcn-ui
• TypeScript
• ESLint
• Prettier
• Jest
• Absolute Imports
• Customizable Package Manager Support (npm, yarn, or pnpm)
• Git Initialization

Requirements

• Node.js >= 20.14.0
• Yarn >= 1.22.18 (if using Yarn as your package manager)
• pnpm >= 8.3.1 (if using pnpm as your package manager)

Installation

Install globally via npm:

npm install -g next-boil

Or, use it directly via npx:

npx next-boil my-next-app

Usage

Basic Usage

Run the CLI with a project name:

next-boil my-next-app

This will:

• Create a directory named my-next-app.
• Clone the default template from the repository.
• Set up your project, ready for development.

Options

| Option | Description | |----------------------------|--------------------------------------------------| | -t, --template <url> | Specify a custom template repository URL | | -f, --force | Force overwrite existing non-empty directories | | -b, --base-dir <path> | Specify a base directory for project creation | | -p, --package-manager | Choose a package manager (npm, yarn, pnpm) | | --no-git | Skip git initialization | | --debug | Show detailed error stack for debugging purposes |

Examples

1. Bootstrap with the default template:

   next-boil my-next-app

2. Use a custom template:

   next-boil my-next-app --template https://github.com/user/my-template

3. Force overwrite an existing directory:

   next-boil my-next-app --force

4. Use a custom base directory:

   next-boil my-next-app --base-dir ~/projects

5. Select a package manager (yarn, npm, or pnpm):

   next-boil my-next-app --package-manager yarn

6. Skip Git initialization:

   next-boil my-next-app --no-git

7. Debug issues with verbose error messages:

   next-boil my-next-app --debug

No Arguments?

Running next-boil without arguments displays the help menu:

next-boil

Next Steps

Once your project is set up, navigate to the project directory and start development:

cd my-next-app
npm install
npm run dev

If you selected a package manager like Yarn or PNPM, replace npm with your chosen package manager.

License

This project is licensed under the MIT License.