my-next-starter-cli
v1.0.1
Published
CLI to generate Next.js starter templates
Downloads
7
Readme
My Next.js Starter CLI
My Next.js Starter CLI is a command-line tool that helps you quickly generate Next.js starter projects with various configurations, including Tailwind CSS, Shadcn-UI, Clerk for authentication, and next-intl
for localization. This CLI makes it easy to set up your Next.js project with the stack you prefer, saving time on initial setup.
Features
- Choose your Stack: Select from different configurations like
intl
,intl-clerk
, orintl-clerk-shadcn
. - Custom App Name: Prompted to enter your custom app name during setup.
- Simple Command: Easily generate projects using a single
npx
command.
Installation
No installation required! Use it directly with npx
:
npx create-next-starter
Usage
When you run the command above, you'll be prompted to:
- Enter your app's name (e.g.,
my-awesome-app
). - Select the project template you want to use.
Example Workflow
Run the CLI command:
npx create-next-starter
Follow the prompts:
- App Name: You might enter something like
my-cool-app
. - Template Selection: Choose from the following:
intl
: Next.js + Tailwind CSS +next-intl
intl-clerk
:intl
+ Clerk for authenticationintl-clerk-shadcn
:intl-clerk
+ Shadcn-UI for additional UI components
- App Name: You might enter something like
The CLI will automatically create a new Next.js project based on your selections.
Example Output
? What is your app's name? my-cool-app
? Which version would you like to install? intl-clerk-shadcn
Running: npx create-next-app@latest --example https://github.com/username/my-next-starter#intl-clerk-shadcn my-cool-app
After running the command, you'll find your new Next.js project in the my-cool-app
directory.
Available Templates
Here are the available templates you can choose from:
- intl: A basic starter with Next.js, Tailwind CSS, and
next-intl
for internationalization. - intl-clerk: Adds Clerk authentication to the
intl
setup. - intl-clerk-shadcn: Includes everything in
intl-clerk
, plus Shadcn-UI for a richer UI component library.
License
This project is licensed under the MIT License. See the LICENSE file for more details.