nextdevkit

NextDevKit: A Comprehensive CLI Toolkit for Next.js Development

NextDevKit is a powerful and intuitive command-line interface (CLI) tool designed to streamline and enhance your Next.js development workflow. It provides a suite of features that help you quickly set up projects, generate components and pages, manage utilities and hooks, and enforce code quality standards—all from the comfort of your terminal.

---

🔑 Key Features

🚀 Project Initialization

• Create New Projects: Quickly scaffold new Next.js projects with customizable configurations.
• Customization Options: Choose TypeScript support, styling solutions (CSS, Sass, Tailwind CSS, Styled Components), and more during setup.

🔧 Project Configuration

• Initialize in Existing Projects: Seamlessly integrate NextDevKit into your current Next.js projects to leverage its powerful features.

📂 File Management

• Add Utilities and Hooks: Easily add pre-built utility functions or custom React hooks to your project. Includes commonly used utilities like isEmpty, isString, and hooks like useAxios.
• Remove Files: Effortlessly remove previously added utilities or hooks from your project.
• List Available Files: View all available utility and hook files that can be added to your project.

🛠 Component and Page Generation

• Generate Components and Pages: Quickly generate new Next.js components or pages using predefined templates.
• Support for JS and TS: Works with both JavaScript and TypeScript projects.
• Customizable Templates: Modify templates to fit your project's specific needs.

📝 Code Quality Tools Setup

• ESLint and Prettier Integration: Set up ESLint and Prettier configurations to maintain consistent code style and quality.
• Husky and lint-staged: Initialize Husky to manage Git hooks and set up pre-commit hooks with lint-staged. Automatically lint and format code before each commit.

💻 Interactive Command Line Interface

• User-Friendly Prompts: Guides you through project setup and configuration with interactive questions.
• Attractive Output: Clear and stylized console output with colorized text and banners for an enhanced terminal experience.

⚙️ Extensible and Customizable

• Project Customization: Tailor project creation with options for TypeScript, styling choices, and more.
• Extend Functionality: Add your own templates and utilities to expand the toolkit's capabilities.

---

📜 Commands Overview

• create [projectName]: Create a new Next.js project with NextDevKit initialized.

  bunx nextdevkit create my-next-app
  

  or

  npx nextdevkit@latest create my-next-app
  

• init: Initialize NextDevKit in an existing Next.js project.

  bunx nextdevkit init
  

  or

  npx nextdevkit@latest init
  

• add [fileName]: Add a utility or custom hook file to your project.

  bunx nextdevkit add useAxios
  

  or

  npx nextdevkit@latest add useAxios
  

• remove [fileName]: Remove a utility or custom hook file from your project.

  bunx nextdevkit remove useAxios
  

  or

  npx nextdevkit@latest remove useAxios
  

• list: List all available utility and hook files.

  bunx nextdevkit list
  

  or

  npx nextdevkit@latest list
  

• generate <type> <name>: Generate a new component or page.

  bunx nextdevkit generate component Navbar
  

  or

  npx nextdevkit@latest generate component Navbar
  

• setup-linters: Set up ESLint, Prettier, Husky, and lint-staged in your project.

  bunx nextdevkit setup-linters
  

  or

  npx nextdevkit@latest setup-linters
  

• help [command]: Display detailed help information for commands.

  bunx nextdevkit help generate
  

  or

  npx nextdevkit@latest help generate
  

---

🌟 Why Use NextDevKit?

• Boost Productivity: Reduce boilerplate code and setup time by automating common tasks.
• Maintain Code Quality: Enforce consistent coding standards with integrated linting and formatting tools.
• Simplify Workflow: Manage project files, components, and configurations with simple commands.
• Adaptable: Suitable for both new and existing Next.js projects, supporting JavaScript and TypeScript.
• Developer-Friendly: Designed with developers in mind, providing helpful prompts and clear documentation.

---

📥 Getting Started

Install and Run with NPX

npx nextdevkit@latest create my-next-app

Initialize in an Existing Project

npx nextdevkit@latest init

---

👨‍💻 About the Creator

NextDevKit is created and maintained by Harshal Katakiya.

• GitHub: https://github.com/Harshalkatakiya
• Website: https://nextdevkit.vercel.app

---

📄 License

This project is licensed under the MIT License.

---

📣 Contribute and Support

Contributions, issues, and feature requests are welcome!

• Repository: https://github.com/Harshalkatakiya/nextdevkit
• Issues: https://github.com/Harshalkatakiya/nextdevkit/issues

---

NextDevKit is your all-in-one toolkit to supercharge your Next.js development experience. Get started today and take your projects to the next level!