🚀 MyStarterCLI - The Awesome CLI Starter Template 🚀

📜 Description

MyStarterCLI is an awesome Command-Line Interface (CLI) tool that helps you generate starter templates for various projects. It provides multiple options, including creating a full-stack project with Next.js and Express, setting up a standalone Express API, and creating a project with Vite and React along with an Express API.

🌐 Table of Contents

• Description
• Features
• Installation
• Usage
• Project Types
• Contributing
• License

💫 Features

• 🚀 Create Next.js projects with a simple Express API.
• 🔥 Set up standalone Express APIs for your projects.
• 🎉 Create Vite and React projects with an integrated Express API.
• 📋 Generate a detailed template-create.md file describing the created project.
• ⚙️ Customize configurations with template-config.json.
• 📦 Install required dependencies automatically.
• 💻 Simple and easy-to-use CLI tool.

📦 Installation

To use MyStarterCLI, make sure you have Node.js and npm installed on your machine. Then, run the following command:

npm install -g my-starter-cli

🔧 Usage

To run MyStarterCLI, simply execute the following command in your terminal:

my-starter-cli

Follow the prompts to choose the project type and, if required, enter a project name. MyStarterCLI will then generate the selected project template, create necessary files and folders, and install the required packages.

💼 Project Types

1. API + Next.js: Create a full-stack project with Next.js and Express. This template includes an Express API with API routes and a Next.js app set up using create-next-app.
2. API: Set up a standalone Express API with API routes for your backend development needs.
3. API + Vite: Generate a project with Vite and React, along with an integrated Express API. This template combines the power of Vite and Express for efficient development.

🤝 Contributing

Contributions to MyStarterCLI are more than welcome! If you find any issues, have suggestions for improvement, or want to add new features, please open an issue or submit a pull request.

📄 License

MyStarterCLI is open-source and released under the MIT License. Feel free to use and modify this tool for your projects.

🔧 Packages Used

• inquirer: A collection of common interactive command-line user interfaces.
• shelljs: A portable Unix shell commands for Node.js.
• fs: The built-in Node.js file system module.
• path: The built-in Node.js path module.

🛠️ How to Install

To get started with MyStarterCLI, you need Node.js and npm installed on your machine. Follow these steps:

1. Install Node.js and npm from the official website: Node.js Download.
2. Open your terminal or command prompt.
3. Install MyStarterCLI globally by running the following command:

npm install -g my-starter-cli

🚀 How to Use

Once MyStarterCLI is installed, you can start using it by running:

my-starter-cli

Follow the prompts to select your desired project type and enter a project name, if applicable. The CLI will then create the selected project template and set up the necessary files and folders. Additionally, it will install the required dependencies for your project.

That's it! You now have a powerful CLI tool to generate starter templates for your projects. Happy coding!