Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
node_modules
node_modules
test/generated-test-cases.js
debug-auth.js
quick-auth-test.js
test-auth-providers.js
verify-auth.js
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- **Conditional API Route Deletion** — deletes the default `api/hello.js` route if using the `src` directory and not the `app` directory.
- **Safe Project Creation** — checks if the current directory is empty when creating a project in the current directory (`.`) and prevents accidental overwrites.
- **ORM Support** — choose between no ORM, Prisma, and Drizzle.
- **Optional Auth Scaffolding** — supports NextAuth.js, Clerk, or Firebase
- **Automated CI/CD Feedback** — Pull Requests now receive automated comments on test status.

## Installation
Expand Down Expand Up @@ -58,6 +59,7 @@ When you run `npx create-next-quick` without a project name, you will be prompte
6. **Enter the names of the pages you want to create (default: none)**
7. **Choose a linter (default: none)**
8. **Choose an ORM (default: none)**
9. **Do you want to use Shadcn UI? (default: Yes)**

Example run:

Expand All @@ -76,13 +78,14 @@ npx create-next-quick
? Choose a linter (default: none): none
? Choose an ORM (default: none): prisma
? Do you want to use Shadcn UI? No
? Choose an authentication provider (default: none): nextauth
```

## Commands

- `npm run dev` — starts the development server.
- `npm run build` — builds the project for production.
- `npm start` — starts the production server.
- `npm run dev` — starts the development server.
- `npm run build` — builds the project for production.
- `npm start` — starts the production server.

## Testing

Expand Down Expand Up @@ -115,8 +118,8 @@ Our CI/CD pipeline will automatically run tests and provide feedback directly on

Before submitting, please ensure:

- Your code follows project style guidelines
- You have tested your changes locally
- Your code follows project style guidelines
- You have tested your changes locally

## License

Expand All @@ -128,4 +131,4 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
<a href="https://github.com/gaureshpai/create-next-quick/graphs/contributors">
<img src="https://contrib.rocks/image?repo=gaureshpai/create-next-quick" />
</a>
</div>
</div>
Loading