Next-Platter: Next.js Project Scaffolding CLI

Welcome to Next-Platter, a CLI tool designed to streamline the creation of new Next.js projects with pre-configured templates.

What is Next-Platter?

Next-Platter is your go-to CLI tool for generating Next.js project templates. Think of it as a plate of templates 🍽️ you can pick from, allowing you to quickly scaffold your Next.js project with minimal setup and best practices already in place.

Purpose

The main goal of Next-Platter is to eliminate the repetitive setup tasks when starting new Next.js projects. Instead of manually configuring tools like Tailwind CSS, TypeScript or Cypress, you can rely on Next-Platter to provide templates with everything set up for you.

Key Features

• Multiple Templates for different project needs.
• Quick Setup with pre-configured tools and best practices.
• Customizable templates that grow with your project.
• Lightweight Tooling focused on essential features without bloat.

Usage

Installation

You can create a new project using this template in three ways:

1. Using npm globally:

   • Install the package globally:

     npm install -g next-platter
     

   • Run the command to create a new project:

     next-platter my-app
     

2. Using npx:

   • Run the following command to create a new project using this template:

     npx next-platter my-app
     

3. Using create-next-app with a template:

   • Alternatively, you can use the create-next-app command with your template:

     npx create-next-app@latest --example https://github.com/Adel2411/next-platter/tree/main/template my-app
     

Running the Project

4. Navigate to your project directory:

   cd my-app
   

5. Start the development server:

   npm run dev
   

6. Open http://localhost:3000 in your browser to see the app.

Available Templates 📦

• Next.js Starter Template: A minimal, clean setup with essential tools like Tailwind CSS, Zustand, Framer Motion, Cypress, and Docker.

(More templates coming soon!)

Folder Structure Overview (for templates)

Each template provides a well-organized folder structure to guide you on where to place pages, components, features, hooks, and more.

(Refer to each template’s README for specific details.)

Docker Support 🐳 (for templates)

Templates include Docker configuration for containerized development.

Testing Integration 🧪 (for templates)

Cypress is pre-configured for end-to-end testing in each template.

Template-Specific Documentation

Each generated project will include its own README with template-specific details on folder structure, features, and usage.

Future Plans

• More templates (e.g., database integration, authentication setups, advanced state management).
• Enhanced CLI features for better user experience.

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.

Contact

• GitHub: Adel2411
• Email: [email protected]

Start your Next.js project faster and smarter with Next-Platter! ⚡