Documentar API ⚡️

Realizar la configuración necesaria para tener documentado tu proyecto final a partir de Swagger.

• Se debe tener documentado el módulo de productos.
• Se debe tener documentado el módulo de carrito
• No realizar documentación de sesiones

Documentación de la API

Pare poder ver la documentación situarse en el siguiente endpoint: /api-docs

Inicio de sesión

A la hora de iniciar el proyecto en producción hay que modificar la api de peticiones de la carpeta src/public/js/utils/api.js reemplazando el puerto 8080 por el puerto 3000

• ADMIN:

  email: admin@gmail.com
  password: 123

• PREMIUM:

  email: premium@gmail.com
  password: 123

• USUARIO:

  email: usuario@gmail.com
  password: 123

Estructura del Proyecto

Dentro del proyecto encontrarás la siguiente estructura de directorios:

├── src/
    ├── config/
    │   └── ...
    └── controllers/
    │   └── ...
    └── dao/
        └── db/
        │   └── ...
        └── memory/
        │   └── ...
        └── models/
        │   └── ...
        └── mongo/
        │   └── ...
        └── patterns/
        │   └── ...
        └── services/
            └── repository/
                └── ...
    │└── lib/
        └── error/
            └── constants/
            │   └── ...
            └── handler/
                └── ...
    │└── middlewares/
    │   └── ...
    └── public/
    │   └── ...
    └── routes/
    │   └── ...
    └── utils/
    │   └── ...
    └── views/
        └── layouts/
        │   └── ...
        └── partials/
            └── ...

• src/config: Archivos de configuración
• src/controllers: Controladores de las rutas
• src/dao: Todo lo relacionado con datos (MEMORY, MONGO)
• src/dao/memory: Métodos para guardar los datos en memoria (archivo.json)
• src/dao/models: Estructura de los datos de MONGODB
• src/dao/mongo: Métodos para guardar los datos en una base de datos mongo
• src/dao/patterns: Diseño de los datos de la aplicación
• src/dao/services: Servicios
• src/dao/services/repository: Selección del dao a utilizar en el proyecto
• src/lib: Librerias compartidas
• src/lib/err: Libreria de custom error
• src/lib/err/constants: Todos los códigos e información de distintos errores
• src/lib/err/handler: Manejador de errores
• src/middlewares: Funciones de validación
• src/public: Carpeta publica para las vistas
• src/routes: Rutas de la API
• src/utils: Archivos que se reutilizarán a lo largo del proyecto
• src/views: Vistas de handlebars para renderizar la interfaz del usuario
• src/views/layouts: Plantillas de handlebars
• src/views/partials: Componentes de handlebars

Instalación

$ npm install # or `pnpm install` or `yarn install`

Configuración del Proyecto con Standard.js

Ir al siguiente Directorio

├── node_modules/
    ├── standard/
        └── ...

En el archivo eslintrc.json pegar la siguiente configuración

{
  "env": {
    "browser": true
  },
  "extends": ["standard", "standard-jsx"]
}

Desarrollo

$ npm start # or `pnpm start` or `yarn start`

Parámetros por linea de comando

Modo de desarrollo

$ npm start --mode

• DEVELOPMENT: Se conecta a la base de datos de desarrollo y el puerto de ejecución del servidor es el 8080 por defecto
• PRODUCTION: Se conecta a la base de datos de producción y el puerto de ejecución del servidor es el 3000 por defecto

Por defecto se usa DEVELOPMENT

Puerto de ejecución del servidor

$ npm start --port

Por defecto se usa el puerto designado por el modo de desarrollo

Persistencia de los datos

$ npm start --store

• MONGO: Los datos se almacenan en una base de datos mongo
• MEMORY: Los datos se almacenan en un archivo .json

Por defecto se usa MONGO

Producción

$ npm build # or `pnpm build` or `yarn build`