aqua-root/README.md

Root Component

# Módulo aqua-root 

Root Component

## Tecnologías

[Aqua-Generator] usa los siguientes proyectos open source:

* [Yeoman]: Generador de estructuras 
* [node.js]: Sistema I/O para backend
* [Karma]: Sistema de Test
* [Webpack]: Empaquetado del componente

## Instalación

Requiere [node.js] v6+. 

Comprobar la versión:

    $ npm --version

### Instalación de las dependencias:

    $ npm install

### Instalación de los typings

    $ typings install

### Instalación del componente en otro proyecto:    
  
    $ npm install --save aqua-root

## Vincular a Git

Para iniciar el repositorio local

    git init

Para vincular el remoto

    git remote add origin http://git.absapp.net/r/argo2/front/components/Root.git
    git push -u origin master

## Test

Lanzar los test:

    $ npm run test

## Ejecución

Lanzar el generador de Yeoman:
    
    $ npm run start

## Distribución

Preparar el componente para distribuir:
    
    $ npm run build

## Documentación

Para la documentación, lanzar:

    $ npm run tsdoc

Y se tendrá disponible en el enlace de [Documentación]


## Publicación

Para publicar el componente, hay que asegurarse de que se modifica la versión:

    <!-- package.json -->
    version: x.x.x
    X.x.x Incrementos de tecnología y compatibilidad descendente
    x.X.x Incrementos de Funcionalidades
    x.x.X Incrementos evolutivos y correctivos que no añaden funcionalidad

Y se incluyen los archivos en el package.json

    $ npm set registry http://npm.absapp.net:4873
    $ npm adduser --registry http://npm.absapp.net:4873

Y después ejecutar:

    $ npm publish

##Licencia

[AQUALOGY]

----

[//]: # (These are reference links used in the body)
   [Documentación]: </docs/index.html>
   [Aqua-Generator]:<#>
   [Yeoman]: <http://yeoman.io>
   [Webpack]: <https://webpack.github.io/>
   [Node.js]: <http://nodejs.org>
   [Karma]: <https://karma-runner.github.io>
   [AQUALOGY]: <https://aqualogybs.net/licenses/aqualogy>