You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 4, 2026. It is now read-only.
A fast and interactive CLI tool to scaffold a new Next.js project with your preferred setup.
7
+
Choose TypeScript, Tailwind CSS, Shadcn UI, Linters, ORMs, and multiple pages in just a few prompts — no boilerplate hassle.
6
8
7
-
`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.
9
+
---
8
10
9
-
## Features
11
+
## 📑 Table of Contents
10
12
11
-
-**CLI Argument for Project Name** — skip the project name prompt by passing the app name as a CLI argument.
12
-
-**Package Manager Detection** — automatically detects installed package managers (`npm`, `yarn`, `pnpm`) and only prompts with available options.
13
-
-**Next.js App Directory** — support for the new Next.js app directory.
14
-
-**Custom Page Generation** — create multiple pages at once.
15
-
-**Linter Support** — choose between no linter, ESLint, and Biome.
16
-
-**Shadcn UI** — automatically installs and configures Shadcn UI with a default style and color.
17
-
-**Clean Project Setup** — removes default favicon and clears public folder.
18
-
-**Empty Default Page** — overwrites the default `page.tsx` or `index.tsx` with an empty template.
19
-
-**Dynamic Metadata** — always overwrites the `layout.tsx` or `layout.jsx` with a minimal template.
20
-
-**Conditional API Route Deletion** — deletes the default `api/hello.js` route if using the `src` directory and not the `app` directory.
21
-
-**Safe Project Creation** — checks if the current directory is empty when creating a project in the current directory (`.`) and prevents accidental overwrites.
22
-
-**ORM Support** — choose between no ORM, Prisma, and Drizzle.
23
-
-**Automated CI/CD Feedback** — Pull Requests now receive automated comments on test status.
⚠️ npx create-next-quick works only with the published npm package. For your fork, use the commands above.
68
+
69
+
🛠 Usage
70
+
With a Project Name
71
+
bash
72
+
Copy code
73
+
node index.js my-app
74
+
Creates a folder my-app with your chosen setup.
75
+
76
+
Without a Project Name
77
+
bash
78
+
Copy code
79
+
node index.js
80
+
You’ll be prompted for options:
81
+
82
+
pgsql
83
+
Copy code
84
+
? Enter project name: my-portfolio
85
+
? Do you want to use TypeScript? (Y/n)
86
+
? Do you want to use Tailwind CSS? (Y/n)
87
+
? Do you want to use the app directory? (Y/n)
88
+
? Enter pages (comma-separated): home, about, contact
89
+
? Choose a linter: None / ESLint / Biome
90
+
? Choose an ORM: None / Prisma / Drizzle
91
+
? Do you want to use Shadcn UI? (Y/n)
92
+
▶️ Example Walkthrough
93
+
bash
94
+
Copy code
95
+
node index.js
96
+
Sample run:
97
+
98
+
pgsql
99
+
Copy code
71
100
? Enter project name: my-portfolio
72
101
? Do you want to use TypeScript? Yes
73
102
? Do you want to use Tailwind CSS? Yes
74
103
? Do you want to use the app directory? Yes
75
-
? Enter the names of the pages you want to create (comma-separated): home, about, contact
76
-
? Choose a linter (default: none): none
77
-
? Choose an ORM (default: none): prisma
104
+
? Enter pages: home, about, contact
105
+
? Choose a linter: none
106
+
? Choose an ORM: prisma
78
107
? Do you want to use Shadcn UI? No
79
-
```
108
+
Done! 🎉 Run your project:
80
109
81
-
## Commands
110
+
bash
111
+
Copy code
112
+
cd my-portfolio
113
+
npm run dev
114
+
🔧 Commands
115
+
npm run dev → Start development server
82
116
83
-
-`npm run dev` — starts the development server.
84
-
-`npm run build` — builds the project for production.
85
-
-`npm start` — starts the production server.
117
+
npm run build → Build for production
86
118
87
-
## Testing
119
+
npm start → Run production server
88
120
89
-
The test suite for `create-next-quick` is designed to be dynamic and data-driven. Test cases are automatically generated based on the available options in `index.js`, ensuring comprehensive coverage as the CLI evolves.
121
+
🧪 Testing
122
+
Generate test cases:
90
123
91
-
To run the tests:
124
+
bash
125
+
Copy code
126
+
npm run test:generate
127
+
Run tests:
92
128
93
-
1.**Generate Test Cases:** First, generate the test cases by running:
94
-
```bash
95
-
npm run test:generate
96
-
```
97
-
This script parses `index.js` and creates `test/generated-test-cases.js`.
98
-
2. **Run Tests:** Then, execute the test suite:
99
-
```bash
100
-
npm test
101
-
```
102
-
This will run all generated test cases using Mocha.
129
+
bash
130
+
Copy code
131
+
npm test
132
+
🤝 Contributing
133
+
Fork & clone repo
103
134
104
-
## Contributing
135
+
Create a branch: git checkout -b feature-name
105
136
106
-
We welcome contributions! Follow these steps:
137
+
Commit changes: git commit -m "Added feature"
107
138
108
-
1. Fork the repository
109
-
2. Create a new branch: `git checkout -b feature-name`
110
-
3. Commit your changes: `git commit -m "Added new feature"`
111
-
4. Push to your branch: `git push origin feature-name`
112
-
5. Open a Pull Request
139
+
Push & open a PR 🎯
113
140
114
-
Our CI/CD pipeline will automatically run tests and provide feedback directly on your Pull Request.
141
+
CI/CD will automatically run tests and comment on your PR.
115
142
116
143
Before submitting, please ensure:
117
144
@@ -126,6 +153,7 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
0 commit comments