@hcd-bsas/list-documents-plugin v0.0.11

vue-cli-plugin

Estructura del proyecto

Este proyecto permite exportar un plugin de Vue 3 para poder listar los documentos que hayan sido escaneados.

Pre-requisitos

Es necesario tener instalado

• Node Js LTS La versión utilizada para el primer desarrollo fue 16.14.0 LTS.

• yarn

  npm install -g yarn

Recomendaciones opcionales para instalar

• Visual Studio Code
• CMDER es una consola de comandos sencilla con algunas sintaxis linux

Instalación

El proyecto javascript esta armado con webpack y algunas librerías adicionales.

Su instalación es sencilla ejecutando en la raíz del directorio el comando install que agregara todas las dependencias necesarias:

    yarn install

Compilación desarrollo

El comando serve compila el proyecto y levanta un servidor en el puerto 8081 donde se podra probar el plugin.

    yarn serve

Compilación productiva y publicación en NPM

Compilación producción

El comando build-library compila el proyecto comprimido para luego poder ser distribuido.

    yarn build-library

Publicación NPM

Posteriormente para poder publicar la librería en NPM se debe:

1) Tener un usuario registrado. Ir al registro...

2) Acceder a la cuenta de NPM de la HDC desde el navegador y agregar como administrador al usuario registrado en la organización @hcd-bsas. Credenciales:

> Usuario: desarrollohcd

> Contraseña:  "la misma que se utiliza en el correo hcddesarrolladoras@gmail.com"

3) Autenticar con el usuario registrado en el paso 1 desde la linea de comandos

    yarn login

4) Asegurase de previamente haber compilado la librería en modo producción (comando build-library).

5) Publicar librería con el comando publish, el cual preguntara cual es el nuevo número de versión. En donde "version": ..* --> El primer número corresponde a cambios grandes, el segundo nuevas funcionalidades y el tercero corrección de errores o cambios menores.

    yarn publish

Nota: En ocasiones da el error "You cannot publish over the previously published versions" al no poder cambiar la versión de la librería desde la linea de comandos. Para ello se debe aumentar el número de versión en la opción version del package.json

Como hacer uso de la librería con NPM

Pero para poder instalar la librería en cualquier otro proyecto se debe correr el comando en el directorio donde el proyecto contenga las librerías javascript.

    yarn add @hcd-bsas/list-documents-plugin