Package Exports
- create-next-quick
- create-next-quick/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (create-next-quick) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
create-next-quick
create-next-quick is a CLI tool that lets you instantly create a new Next.js project with your choice of options.
Why create-next-quick?
create-next-quick
is a lightweight and fast alternative to create-next-app
. It provides an interactive setup process that lets you choose the options you want for your project, such as TypeScript, Tailwind CSS, and the Next.js app directory. It also lets you create multiple pages at once, which can save you a lot of time when starting a new project.
Features
- Interactive Setup — prompts you for project name, TypeScript, Tailwind CSS, and more.
- Next.js App Directory — support for the new Next.js app directory.
- Custom Page Generation — create multiple pages at once.
- Linter Support — choose between no linter, ESLint, and Biome.
- Shadcn UI — automatically install and configure Shadcn UI.
- Clean Project Setup — removes default favicon and clears public folder.
- Empty Default Page — overwrites the default
page.tsx
orindex.tsx
with an empty template. - Dynamic Metadata — updates the
layout.tsx
orlayout.jsx
metadata (title and description) based on project name.
Installation
You don’t need to install it globally — run it instantly with npx
:
npx create-next-quick
🛠 Usage
When you run npx create-next-quick
, you will be prompted to:
- Enter Project Name — e.g.,
my-app
- Choose to use TypeScript (default: Yes)
- Choose to use Tailwind CSS (default: Yes)
- Choose to use the app directory (default: Yes)
- Enter the names of the pages you want to create (default: none)
- Choose a linter (default: none)
- Choose to use Shadcn UI (default: No)
Example run:
npx create-next-quick
Example Walkthrough
? Enter project name: my-portfolio
? Do you want to use TypeScript? Yes
? Do you want to use Tailwind CSS? Yes
? Do you want to use the app directory? Yes
? Enter the names of the pages you want to create (comma-separated): home, about, contact
Folder Structure
After running, your project will look like this:
my-app/
├── app/
│ ├── page.tsx
│ ├── about/
│ │ └── page.tsx
│ └── contact/
│ └── page.tsx
├── public/
├── package.json
└── README.md
Commands
npm run dev
— starts the development server.npm run build
— builds the project for production.npm start
— starts the production server.npm run lint
— lints the project.
Contributing
We welcome contributions! Follow these steps:
- Fork the repository
- Create a new branch:
git checkout -b feature-name
- Commit your changes:
git commit -m "Added new feature"
- Push to your branch:
git push origin feature-name
- Open a Pull Request
Before submitting, please ensure:
- Your code follows project style guidelines
- You have tested your changes locally
License
This project is licensed under the MIT License. See the LICENSE file for details.
Credits: Special thanks to @harshgupta20 for the original idea and inspiration for this project.