Gitbook-start-heroku-P9-josue-nayra NPM

Práctica 9. Sistemas y Tecnologías Web

LocalStrategy y Base de Datos

gitbook-start-heroku-P9-josue-nayra @0.1.8

Plugin npm: gitbook-start-heroku-P9-josue-nayra
Versión: 0.1.8

Objetivo:

El servidor proveído por el plugin (heroku) deberá autenticar al lector del libro usando LocalStrategy y una base de datos en la que se guarda la información acerca de los usuarios.

Para la Base de datos se ha utilizado Sequelize y se ha realizado el despliegue en Heroku.

Pasos a seguir para la utilización de los plugins

1- Descargar el paquete inicial: gitbook-start-josue-nayra

$ npm install -g gitbook-start-josue-nayra

Nota: Si ha tenido algún problema a la hora de instalar el paquete inicial, compruebe que no tiene creado previamente el directorio "~/.gitbook-start".

2- Crear el libro mediante el comando:

$ gitbook-start -d <directorio> --autor <autor> --name <nombre_libro> --url <url_repo>

Se construye así la estructura inicial por gitbook-start, es decir, la jerarquía de directorios conteniendo los scripts y ficheros markdown para el libro.

3- Colocarse en la carpeta que contiene el libro.

$ cd <directorio en el que se ha desplegado el libro>

4- Instalar las dependencias descritas en el package.json necesarias mediante el comando:

$ npm install

5- Instalar el plugin requerido como dependendecia con la opción --save, como por ejemplo: gitbook-start-heroku-P9-es-josue-nayra para el despliegue en Heroku.

$ npm install --save gitbook-start-heroku-P9-josue-nayra

6- Puede tener el repositorio remoto actualizado mediante una de las tareas descritas en el gulpfile.

$ gulp push --mensaje <mensaje commit>

7- Nos logueamos en Heroku a través del siguiente comando:

$ heroku login

8- Ahora debemos asignarle un nombre a la aplicación de Heroku que se creará en el siguiente paso. Para ello accedemos al package.json y rellenamos la sección de Heroku:

  "Heroku":{
    "nombre_app": "<nombre de la aplicación"
  }

9- Para construir el libro disponemos de una tarea en el gulpfile denominada "build".

$ gulp build

10- Una vez que hemos instalado el plugin de Heroku, ejecutamos el deploy:

$ gitbook-start --deploy heroku

Una vez ejecutado el comando anterior, se generará automáticamente en el gulpfile.js una tarea llamada "deploy-<máquina en la que realizar el despliegue>" que permitirá al usuario actualizar el contenido de dicha máquina.

gulp.task("deploy-<máquina en la que realizar el despliegue>", function(){
    require(path.join(basePath, 'node_modules','<plugin de depliegue>')).deploy(...);
});

11- Ahora el usuario podrá desplegar en heroku y se le actualizarán los cambios en el Gitbook:

$ gulp deploy-heroku

Tareas Gulp

push

Tarea habilitada para que el usuario pueda actualizar el repositorio que contiene el gitbook. Está disponible una opción --mensaje para especificar el mensaje del commit.

$ gulp push --mensaje <mensaje del commit>

instalar_recursos

Tarea que permite al usuario instalar plugins y dependencias necesarias para su gitbook.

$ gulp instalar_recursos

build

Tarea para la construcción del libro.

$ gulp build

deploy

Tarea deploy genérica que actualiza las gh-pages del gitbook.

$ gulp deploy

deploy-heroku

Tarea generada posteriormente a la realización y ejecución del comando gitbook-start --deploy, que permite al usuario realizar posteriores despliegues y actualizaciones de su gitbook en Heroku con gulp. Por ejemplo, en el caso de que el usuario despliegue en Heroku, después de haber desplegado con la opción gitbook-start --deploy heroku, en el gulpfile se generará una tarea con el nombre deploy-heroku.