api-starter-cli/README.md

Una CLI interactiva para inicializar proyectos Node.js con Express, plantillas con capas, y opciones de base de datos (MongoDB/Sequelize).

# api-starter-cli
✨ Una CLI interactiva para inicializar proyectos con plantillas personalizadas de Express y una experiencia de usuario mejorada.🚀 

## Uso Rápido
La forma más sencilla de comenzar un nuevo proyecto con api-starter-cli es usando
**npx**:

```
npx api-starter-cli create my-new-project
```
Si no especificas un nombre de proyecto, la CLI te lo preguntará interactivamente.

## 💻 Instalación y Ejecución
Tienes dos formas principales de usar api-starter-cli:
- **Opción 1:** 
  Usar con npx (Recomendado)
  
  npx es una herramienta que viene con npm (desde la versión 5.2.0) y te permite ejecutar paquetes del registro de npm sin necesidad de instalarlos globalmente. 
  
  Esto es ideal para herramientas de inicialización de proyectos, ya que siempre usarás la versión más reciente sin preocuparte por actualizaciones globales.
  
  Para usar api-starter-cli con npx, simplemente ejecuta:
  
  ```
  npx api-starter-cli create [nombre-de-tu-proyecto]
  ```
    Ejemplo:
```npx api-starter-cli create my-express-app```

    O simplemente:npx ```api-starter-cli create```

    La CLI te pedirá el nombre del proyecto interactivamente.
- **Opción 2:** Instalación Global
  
  Si prefieres tener api-starter-cli disponible en cualquier momento en tu terminal sin depender de npx, puedes instalarla globalmente.
  
  Instala la CLI globalmente:
  ```
  npm install -g api-starter-cli
  ```

    o si usas Yarn:
    ```
    yarn global add api-starter-cli
    ```
    Usa la CLI directamente:
    Una vez instalada globalmente, puedes invocarla directamente desde cualquier lugar:
    ```
    astarter create [nombre-de-tu-proyecto]
    ```
    Ejemplo: 
    ```
    astarter create my-express-api
    ```
    O para una creación interactiva:
    ```
    astarter create
    ```
## 📚 Plantillas Disponibles

Actualmente, `api-starter-cli` soporta las siguientes plantillas de proyecto:

* **`express-api-basic`**: Una API REST básica configurada con Express.js. Ideal para proyectos sencillos o para empezar rápidamente.
* **`express-api-layered`**: Una API REST con arquitectura basada en capas configurada con Express.js. **Esta plantilla te ofrece la opción de integrar una base de datos al momento de la creación, permitiéndote elegir entre:**
    * **MongoDB** (con Mongoose)
    * **SQL** (con Sequelize, soportando dialectos como PostgreSQL, MySQL y SQLite)
    * **Prisma** (un ORM moderno, compatible con PostgreSQL, MySQL, SQLite y MongoDB)

**¡Pronto más plantillas!**

Al ejecutar el comando create, la CLI te guiará para seleccionar la plantilla que deseas usar.

## ✨ Características 

- **Interfaz Interactiva:** 
Menús amigables y preguntas claras para guiar la creación del proyecto.

- **Selección de Plantillas:** 
Elige entre diversas plantillas de proyecto.

- **Manejo Inteligente de Directorios:** 
Gestiona proyectos en directorios existentes o crea nuevos.

- **Instalación Automática de Dependencias:** 
Opción para instalar las dependencias del proyecto automáticamente después de la creación.

- **Mensajes Claros y Coloreados:** 
Feedback visual para una mejor experiencia de usuario.

## 📄 Licencia

Este proyecto está bajo la Licencia 

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/DanielRiverol/api-starter-cli/tree/main?tab=MIT-1-ov-file)