*************************************
Instalación del entorno de desarrollo
*************************************

Desarrollo en cliente
=====================
El cliente SAC-Foreccsa se ha desarrollado usando las herramientas necesarias de JavaScript.
Para la gestión de las diferentes fases de desarrollo nos apoyamos en la herramienta npm[`1`_] basada en Node, como gestor de paquetes. La instalación de esta herramienta la puede encontrar en el siguiente tutorial[`2`_]. Una vez instalada la herramienta procederemos a descargarnos el repositorio de código. Para ello utilizaremos la herramienta de gestión de versiones Git[`3`_]. Puede instalar Git en su máquina siguiendo el tutorial[`4`_].

Clonamos el repositorio del código del SAC-Foreccsa::

    $ git clone https://github.com/michogar/sat-foreccsa.git

Para instalar las dependencias, nos situamos dentro del raiz del proyecto, a la altura del archivo ``package.json`` y ejecutamos::

    $ npm install

Comprobaremos que todo ha ido de manera correcta si no aparece en la consola ningún mensaje de error y aparece una carpeta ``node_modules`` en el directorio raiz de la aplicación.

Seguidamente deberemos instalar las dependencias de nuestro portal. Para ello::

    $ bower install

lo que nos creará la carpeta bower_components con nuestras librerías dentro.

Tareas de desarrollo
====================

Gulp
****
Mediante las tareas de Gulp hemos automatizado parte del proceso de desarrollo de nuestro visor. A continuación enumeramos las tareas así como el
flujo de uso de las mismas.

Para ejecutar la tarea de Gulp se deberá desde la consola::

    $ gulp <nombre_de_la_tarea>

Por orden las tareas serán:

- clean: Elimina la carpeta dist
- default(browser-sync): arranca un servidor en la ruta `localhost:3000` para poder desarrollar
- copy:config: copia los archivos de la carpeta config y de la carpeta data
- dist:<entorno>: genera una carpeta dist con el visor para desarrollo (sin minificar) o para producción
- imagemin: minifica las imágenes
- copy:fonts: copia las fuentes en la carpeta dist
- deploy:<entorno>: hace una copia de la carpeta dist en el servidor, en la ruta `/var/wwww/sat-foreccsa`. Comprobar los permisos para acceder al servidor ya que esta herramienta hace uso de ssh
- cachebust: renombra los archivos .js y .css para evitar los cachés de los navegadores. Recomendado solo en desarrollo.


npm
****

Con *npm* lanzaremos otras tareas, estas referentes a la documentación. Para lanzar las tareas de npm deberemos::

    $ npm run <nombre_de_la_tarea>

Las tareas serían:

- prepublish:doc: generala carpeta html de la documentación
- publish:doc: copia la documentación en el servidor.

Para poder generar documentación deberá tener instalado sphynx-rst o cualquier otro gestor de documentación en formato RST


.. _1: https://www.npmjs.com/
.. _2: http://howtonode.org/how-to-install-nodejs
.. _3: http://www.git-scm.com/
.. _4: http://git-scm.com/book/en/v2/Getting-Started-Installing-Git