# @hcd-bsas/list-documents-plugin

> ## Estructura del proyecto

Latest version **0.0.11** (published 2022-11-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hcd-bsas/list-documents-plugin
pnpm add @hcd-bsas/list-documents-plugin
yarn add @hcd-bsas/list-documents-plugin
bun add @hcd-bsas/list-documents-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.11 |
| Published | 2022-11-15 |
| First published | 2022-07-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | fscorza, edifierd, desarrollohcd |

## Links

- npm: https://www.npmjs.com/package/@hcd-bsas/list-documents-plugin
- npm.io page: https://npm.io/package/@hcd-bsas/list-documents-plugin

## Dependencies (1)

- [vue-sweetalert2](https://npm.io/package/vue-sweetalert2.md) ^5.0.5

## Recent versions

- 0.0.11 (latest) — 2022-11-15
- 0.0.10 — 2022-11-15
- 0.0.9 — 2022-11-09
- 0.0.8 — 2022-11-08
- 0.0.5 — 2022-08-04
- 0.0.4 — 2022-08-02
- 0.0.3 — 2022-07-01
- 0.0.2 — 2022-07-01
- 0.0.1 — 2022-07-01

## README

# vue-cli-plugin

## Estructura del proyecto

Este proyecto permite exportar un [plugin](https://vuejs.org/guide/reusability/plugins.html) de [Vue 3](https://vuejs.org/guide/introduction.html) para poder listar los documentos que hayan sido escaneados. 

## Pre-requisitos

### Es necesario tener instalado

* [Node Js LTS](https://nodejs.org/en/) La versión utilizada para el primer desarrollo fue 16.14.0 LTS.
* [yarn](https://yarnpkg.com/) 

    ~~~ 
    npm install -g yarn
    ~~~

### Recomendaciones opcionales para instalar

* [Visual Studio Code](https://code.visualstudio.com/)
* [CMDER](https://github.com/cmderdev/cmder) es una consola de comandos sencilla con algunas sintaxis linux

## Instalación

El proyecto javascript esta armado con [webpack](https://webpack.js.org/concepts/) 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](https://www.npmjs.com/) se debe:

1) Tener un usuario registrado. [Ir al registro...](https://www.npmjs.com/signup)

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
~~~

---
_Source: https://npm.io/package/@hcd-bsas/list-documents-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._