UNPKG

create-nextpress

Version:

A CLI for creating Next.js projects with shadcn/ui, Prisma, better-auth, and zustand in the highest speed and performance

196 lines (142 loc) • 7.14 kB
<div align="center"> <a href="https://github.com/Nextpress-cc"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://foshati.storage.c2.liara.space/Nextpress.png"> <img alt="Nextpress logo" src="https://foshati.storage.c2.liara.space/Nextpress.png" height="150" style="border-radius: 12px;"> </picture> </a> <h1>Nextpress</h1> <a href="https://www.npmjs.com/package/create-nextpress"><img alt="NPM version" src="https://img.shields.io/npm/v/create-nextpress.svg?style=for-the-badge&labelColor=000000&color=0066FF&borderRadius=8"></a> <a href="https://www.npmjs.com/package/create-nextpress"><img alt="Download Count" src="https://img.shields.io/npm/dt/create-nextpress.svg?style=for-the-badge&labelColor=000000&color=0066FF&borderRadius=8"></a> <a href="https://github.com/Nextpress-cc/create-nextpress/blob/main/LICENSE"><img alt="MIT License" src="https://img.shields.io/badge/license-MIT-0066FF.svg?style=for-the-badge&labelColor=000000&borderRadius=8"></a> <a href="https://github.com/Nextpress-cc"><img alt="GitHub" src="https://img.shields.io/badge/GitHub-Nextpress-0066FF.svg?style=for-the-badge&logo=github&labelColor=000000&logoWidth=20&borderRadius=8"></a> </div> # Create NextPress v1.4.7 The ultimate CLI for creating high-performance Next.js projects with pre-configured **shadcn/ui**, **Prisma**, **better-auth**, and **zustand** - all optimized for maximum developer productivity. ## Why NextPress? šŸš€ NextPress accelerates your Next.js development by providing: - šŸ”„ **Blazing Fast Setup**: 3x faster than traditional project initialization - 🧩 **Best-in-class Integrations**: Perfectly configured modern tools - šŸ› ļø **Zero Configuration**: Immediate productivity with no manual setup - šŸ“± **Responsive by Default**: Mobile-friendly UI components - šŸ”’ **Built-in Authentication**: Secure user management out of the box - ⚔ **Turbopack Support**: Next.js built-in compiler for faster development ## Features ✨ - ⚔ **Next.js 15+** with TypeScript & Tailwind CSS - šŸ“¦ **Premium Integrated Tools**: - [**shadcn/ui**](https://ui.shadcn.com): Beautifully designed, accessible components - [**Prisma ORM**](https://prisma.io): Type-safe database toolkit with auto-migration - [**better-auth**](https://github.com/Nextpress-cc/better-auth): Enterprise-grade authentication - [**zustand**](https://github.com/pmndrs/zustand): Lightweight state management - šŸ”„ **Concurrent Installation**: Multi-threaded dependency setup - šŸ› ļø **Automatic Configuration**: Zero manual setup required - šŸ“Š **SEO Optimized**: Best practices for search engines built-in - 🌐 **Internationalization Ready**: Easily add multi-language support - šŸš€ **Fast Mode**: Skip audits and use cache for even faster installation - šŸ“ **Flexible Directory Structure**: Optional src directory support ## Quick Start šŸš€ Create a new NextPress project with a single command: ```bash npx create-nextpress@latest ``` Or use with your preferred package manager: ```bash # Using npm npm create nextpress@latest # Using yarn yarn create nextpress # Using pnpm pnpm create nextpress # Using bun bunx create-nextpress ``` ## Step-by-Step Guide šŸ“ 1. Run the command above 2. Enter your project name (e.g., `my-awesome-app`) 3. Select your preferred package manager: - npm - yarn - pnpm - bun 4. Wait for automatic setup (typically 1-3 minutes) 5. Start development: ```bash cd my-project npm run dev # or yarn dev, pnpm dev, bun run dev ``` 6. Open http://localhost:3000 to see your new application! ## Advanced Options āš™ļø ```bash # Create fast project bunx create-nextpress@latest my-project --bun --fast # Create in current directory npx create-nextpress@latest . # Create with specific name npx create-nextpress@latest my-project # Specify package manager npx create-nextpress@latest --pnpm # Supported: --npm, --yarn, --pnpm, --bun # Advanced configuration npx create-nextpress@latest my-project --debug --concurrency 4 --fast # Skip bundled package installations npx create-nextpress@latest --skip-install # Disable progress tracking npx create-nextpress@latest --no-progress # Check CLI version npx create-nextpress@latest --version ``` ## System Requirements šŸ“‹ - Node.js 18.0.0 or later - macOS, Windows, or Linux - Supported package manager (npm, yarn, pnpm, or bun) ## Performance Benchmarks šŸ“Š | FEATURE | PERFORMANCE IMPACT | | ---------------------- | ------------------ | | Concurrent Installs | 3x faster | | Fast Mode | 2x faster | | Parallel Prisma Setup | 40% faster | | Optimized Dependencies | 2x smaller bundle | | Cold Start Time | <500ms | | Turbopack | 10x faster HMR | ## Project Structure ``` my-project/ ā”œā”€ā”€ src/ # Source directory (optional, enabled by default) │ ā”œā”€ā”€ app/ # Next.js App Router │ ā”œā”€ā”€ components/ # UI components (shadcn/ui) │ │ ā”œā”€ā”€ ui/ # shadcn/ui components │ │ └── custom/ # Your custom components │ └── lib/ # Utility functions and shared code ā”œā”€ā”€ prisma/ # Prisma schema and migrations │ ā”œā”€ā”€ schema.prisma # Database schema definition │ └── migrations/ # Auto-generated migrations ā”œā”€ā”€ public/ # Static assets ā”œā”€ā”€ .env # Environment variables ā”œā”€ā”€ .eslintrc.json # ESLint configuration ā”œā”€ā”€ next.config.js # Next.js configuration ā”œā”€ā”€ package.json # Project dependencies ā”œā”€ā”€ tailwind.config.js # Tailwind CSS configuration ā”œā”€ā”€ tsconfig.json # TypeScript configuration └── README.md # Project documentation ``` ## Documentation šŸ“š For detailed documentation and tutorials, visit [comming soon](https://nextpress.dev/docs) ## FAQ ### How is concurrent installation implemented? NextPress uses a custom concurrency engine that leverages your CPU cores for parallel package installation. This dramatically speeds up the setup process, especially on machines with multiple cores. ### Can I use NextPress for production applications? Absolutely! NextPress follows best practices and includes enterprise-grade libraries that make it ideal for both small projects and production applications. ```bash npm install -g create-nextpress@latest ``` ### How can I customize the database connection? Edit the `prisma/schema.prisma` file to configure your database connection. NextPress supports PostgreSQL, MySQL, SQLite, SQL Server, MongoDB, and CockroachDB through Prisma. ## Contributing šŸ¤ We welcome contributions! Please see our [contributing guidelines](https://github.com/Nextpress-cc/create-nextpress/blob/main/CONTRIBUTING.md) for details. ## License šŸ“œ [MIT License](https://github.com/Nextpress-cc/create-nextpress/blob/main/LICENSE) --- <div align="center"> ✨ Built with ā¤ļø by the NextPress team ✨<br> <a href="https://github.com/Nextpress-cc">Nextpress.cc</a> </div>