FARA-BACK CLI

fara-back es un scaffolding generator para proyectos backend en Node.js con Express, Passport y MongoDB. Permite crear un proyecto funcional con todas las carpetas, archivos y configuraciones básicas sin necesidad de instalar nada globalmente.

Instalación

• Sin instalación global (recomendado)

npx fara-back

Ejecuta temporalmente el CLI y genera la estructura del proyecto en la carpeta actual.

• Con instalación global (opcional)

npm install -g fara-back
fara-back

Que hace

Al ejecutar fara-back, se genera automáticamente:

Archivos raíz

• package.json → configurado con dependencias básicas y script start.
• .env → con variables de entorno de ejemplo (PORT, FRONTURL, MONGODB, etc.).
• .gitignore → ignora node_modules y .env.

Carpeta src/

• Configuración

  • src/config/env.config.js → lectura de .env.
  • src/config/passport.config.js → configuración de Passport JWT.
  • src/config/enums.config.js → enums y constantes.

• DAO y modelo de datos

  • src/dao/mongo.js → conexión a MongoDB.
  • src/dao/model/user.model.js → esquema de usuarios con Mongoose.
  • src/dao/manager/ → managers para operaciones de base de datos.

• Rutas

  • src/routes/index.router.js → punto de entrada de rutas.
  • src/routes/user.router.js → rutas de usuario.
  • src/routes/router.js → clase base para rutas con políticas y Passport.

• Controladores

  • src/controller/user.controller.js → controlador de usuario con manejo de errores.

• Servicios

  • src/services/user.service.js → lógica de negocio.

• Repositorios

  • src/repositories/ → repositorios para manejar acceso a datos.

• Utilidades

  • src/utils/dirname.utils.js → obtención de __dirname en ESM.
  • src/utils/custom-exceptions.utils.js → excepciones personalizadas.

• Archivo principal

  • src/app.js → archivo de entrada del proyecto con Express, CORS, Passport y rutas cargadas.

Instrucciones de uso

1. Clonar o generar el proyecto con npx fara-back.
2. Entrar a la carpeta del proyecto y ejecutar:

npm install

MONGODB=<tu_url_de_conexion>

node src/app.js