@nik-1207/project-initializer

CLI Project Initializer for Node.js Projects

The CLI Project Initializer is a Node.js command-line tool designed to streamline the process of creating new Node.js projects by automating the project setup. With this tool, you can quickly create new projects with just a few simple commands.

Table of Contents

1. Introduction
2. Scope
3. Predefined Project Templates
4. Constraints
5. Future Enhancements
6. Installation
7. Usage
8. Contributing
9. License
10. Version Change Log

Introduction

The CLI Project Initializer is a user-friendly Node.js command-line tool that simplifies the process of creating new Node.js projects. It prompts you for necessary project details and generates a basic project structure with the specified configurations.

Scope

The CLI Project Initializer aims to:

• Provide a simple and intuitive interface for initializing new Node.js projects.

User Interaction

The CLI tool interacts with the user through the command-line interface to gather the following information:

• Project Title: A string representing the name of the new project.
• Package Manager: A brief description of the project.
• Project Type: Type of project (js or ts).

Project Generation

After receiving the user's inputs, the CLI tool:

• Creates a new project directory with the provided project title.

Usability

The CLI tool provides clear instructions and prompts to guide users through the project initialization process. It handles invalid inputs gracefully and provides helpful error messages when needed.

Performance

The project initialization process is designed to be efficient and completed in a reasonable time, even for larger templates.

Constraints

• The CLI tool is developed using Node.js and requires Node.js and npm to be installed on the user's machine.

Future Enhancements

• Implement version control integration to initialize projects directly from Git repositories.

Installation

To use the CLI Project Initializer, you need to have Node.js and npm installed on your machine. You can install the tool globally using npm:

npm install -g @nik-1207/project-initializer

Usage

To initialize a new Node.js project, run the following command:

node-project init

The CLI tool will prompt you for project details and create the project structure based on your inputs.

Version Change Log

v2.0.0 New Features and Enhancements:

• TS Node (TypeScript) Projects: Create TypeScript projects with the power of ts-node, making development seamless and efficient.

• Node (TypeScript) Projects: Set up Node.js projects with TypeScript, combining flexibility and type safety.

• JavaScript Projects: Whether it's classic or modern JavaScript, our tool now supports hassle-free project creation.

• Auto Dependency Installation: Say goodbye to manual installations. Our tool now handles dependency setup automatically, getting you up and running in no time.

• Improved Configs: We've overhauled our template files to provide you with even more robust ESLint and TypeScript lint configurations, ensuring your code is top-notch from the start.

• Fix failing scripts.

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.