nls-kit v1.0.3

nls-kit

nls-kit is a Node.js CLI tool for quickly bootstrapping a Next.js project pre-configured with modern libraries and components like lucide-react and shadcn-ui. This tool automates the setup process, saving you time and effort.

Key Features

• Next.js Initialization: Creates a new Next.js project using create-next-app.
• Lucide-React Installation: Adds the lucide-react icon library for modern, lightweight icons.
• shadcn-ui Setup: Installs and configures all shadcn-ui components, giving you access to a pre-built design system.
• Fully Automated Process: From project creation to component installation, everything is streamlined.

Installation

You can run the tool directly with npx, no global installation required:

npx nls-kit@latest <your-app-name>

Replace <your-app-name> with the desired name for your application.

How to Use

1. Run the following command, replacing <your-app-name> with your project name:

   npx nls-kit@latest <your-app-name>

2. The tool will:

   • Initialize a new Next.js project.
   • Install lucide-react for icons.
   • Set up shadcn-ui and add all its components.

3. Once the process completes, navigate to your new project folder:

   cd <your-app-name>

4. Start developing your project!

Prerequisites

• Node.js: Ensure you have Node.js installed on your system.
• npm: Comes with Node.js installations and is used for dependency management.

Error Handling

If the tool encounters an issue, it will display an error message and exit. Common errors include:

• Missing Node.js or npm.
• Invalid application name.
• Network issues during package installation.