js-app-cli v1.0.3

js-app-cli 🚀

js-app-cli is a powerful Command-Line Interface (CLI) tool designed to simplify the process of initializing JavaScript boilerplate projects. It supports popular frameworks like Express and Next.js and allows users to use their own repositories for more flexibility.

Table of Contents

• Features
• Installation
• Usage
• Step-by-Step Guide
• Boilerplates
• Examples
• Contributing
• License
• Author
• Future Plans
• Feedback

Features

• ⚡ Quick Project Setup: Initialize your project with predefined or custom boilerplates in seconds.
• 🔧 Built-in Dependencies Installation: Automatically installs dependencies for the selected boilerplate.
• 🏢 Custom Project Directory Support: Choose where your project will be initialized.
• 🎨 Clean Git Repository: Removes boilerplate Git history and initializes a fresh repository for your project.
• 🌐 Custom Repository Support: Use your own Git repository to initialize projects.
• 📈 Expandable Framework Support: Currently supports Express and Next.js with plans for more in the future.

Installation

Install the CLI tool globally using npm:

npm install -g js-app-cli

Usage

Using js-app-cli is straightforward and interactive.

Step-by-Step Guide

1. Launch the CLI:

   js-app-cli

2. View Available Boilerplates: The CLI will display a list of available boilerplates (e.g., Express, Next.js) and an option to use your own repository.

3. Choose a Boilerplate or Enter Your Repository:

   • Select a predefined boilerplate (e.g., express or next).
   • Or, enter your custom Git repository URL.

4. Specify the Project Directory: Provide the directory where your project should be created:

   • Use . for the current directory.
   • Provide a relative or absolute path for a new directory.

5. Follow the Prompts:

   • The CLI will clone the selected boilerplate or custom repository.
   • Remove the existing Git history.
   • Install dependencies.
   • Initialize a new Git repository.
   • Prompt you to add a commit message.

6. Done!: Navigate to your project directory and start coding:

   cd <your-project-directory>

Boilerplates

Available Boilerplates

1. Express

• Repository: nodejs-boilerplate
• Description: A robust Node.js boilerplate for Express applications.
• Author: Foyzul Karim

2. Next.js

• Repository: Next-js-Boilerplate
• Description: A comprehensive boilerplate for Next.js applications.
• Author: Remi Wg

Examples

Example 1: Creating an Express Project

js-app-cli

Available boilerplates:
1. EXPRESS - A robust Node.js boilerplate for Express applications.
2. NEXT - A comprehensive boilerplate for Next.js applications.
3. Use your own repository

Choose an option by entering the corresponding number: 1
You selected: EXPRESS
Description: A robust Node.js boilerplate for Express applications.
Author: Foyzul Karim

Enter the project directory (use . for the current directory): my-express-app
Cloning the express boilerplate...
Removing existing Git history...
Installing dependencies...
Initializing a new Git repository...
Staging files...

Enter a commit message: Initial commit for my Express app

All set! 🚀
Navigate to your project directory:
  cd my-express-app

Example 2: Using a Custom Repository

js-app-cli

Available boilerplates:
1. EXPRESS - A robust Node.js boilerplate for Express applications.
2. NEXT - A comprehensive boilerplate for Next.js applications.
3. Use your own repository

Choose an option by entering the corresponding number: 3
Enter your Git repository URL: https://github.com/your-username/your-repo.git

Enter the project directory (use . for the current directory): custom-project
Cloning the repository...
Removing existing Git history...
Installing dependencies...
Initializing a new Git repository...
Staging files...

Enter a commit message: Initial commit for my custom project

All set! 🚀
Navigate to your project directory:
  cd custom-project

Contributing

Contributions are welcome! Here's how you can help:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/my-feature

3. Commit your changes:

   git commit -m 'Add a new feature'

4. Push to your branch:

   git push origin feature/my-feature

5. Open a pull request on GitHub.

For feature requests or bug reports, feel free to open an issue on the GitHub repository.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Author

Developed with ❤️ by Md. Mamun Hossain.

• GitHub: Muhammed-Mamun
• Email: muhammed.mamun.131@gmail.com

Future Plans

• Add support for more frameworks like React, Angular, and Vue.js.
• Provide options for advanced configurations during project setup.
• Allow users to define and add custom boilerplates to the CLI.

Feedback

If you encounter any issues or have suggestions, please feel free to open an issue or submit feedback on the GitHub repository.