npm package: @hcd-bsas/bootstrap5
Description: ## Estructura del proyecto
Latest version: 0.0.2


# Bootstrap 5 modificado

## Estructura del proyecto

Desde el archivo index.js se importan los estilos [sass](https://sass-lang.com/guide) de [bootstrap 5](https://getbootstrap.com/docs/5.2/getting-started/introduction/) y los iconos. Con sass se modifican las clases originales para que funcionen solo dentro de un contenedor con el id **hcd-bootstrap**. Ademas se exporta un javascript con todas los [componentes](https://getbootstrap.com/docs/5.2/getting-started/introduction/#js-components) disponibles en la librería bootstrap.

## 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 sin comprimirlo y activa la opción [watch](https://webpack.js.org/configuration/watch/) que permite a webpack observar los archivos y recompilarlos si cambian.

~~~
    yarn serve
~~~

Este archivo compilado se encontrara en el directorio **dist** y se puede probar haciendo uso del **test.html** que se encuentra en la raíz y se puede abrir con cualquier navegador web.

## Compilación productiva y publicación en NPM

### Compilación producción

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

~~~
    yarn build
~~~

### 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 librería **bootstrap5** dentro de 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**).

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 error 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/bootstrap5
~~~

Luego es necesario importar los archivos **hcd-bootstrap.min.css** y **hcd-bootstrap.min.js**, por ejemplo:

~~~
    // Hoja de estilos css
    <link rel="stylesheet" href="../node_modules/@hcd-bsas/bootstrap5/dist/hcd-bootstrap.min.css" />

    // Librería javascript SIN DEPENDENCIA DE JQUERY
    <script src="../node_modules/@hcd-bsas/bootstrap5/dist/hcd-bootstrap.min.js"></script>
~~~

La documentación especifica de como usar bootstrap se puede leer en la web oficial:

### [Documentación Bootstrap5](https://getbootstrap.com/)