gitbook-start-heroku-p7-josue-nayra

Práctica 7. Sistemas y Tecnologías Web

Plugin: Autenticación OAuth con Passport

El servidor proveído por el plugin (sea iaas o heroku) deberá autenticar que el lector del libro pertenece a una organización dada de GitHub (por ejemplo ULL-ESIT-SYTW-1617). Si es el caso que pertenece podrá seguir leyendo el libro, sino será redirigido a la ruta de autenticación.

Plugin: gitbook-start-heroku-p7-josue-nayra

Versiones de los paquetes:

• gitbook-start-josue-nayra: latest
• gitbook-start-heroku-p7-josue-nayra: latest (nuevo paquete para esta práctica)
• gitbook-start-iaas-ull-es-josue-nayra: @1.1.9

Pasos a seguir:

Seguimos los pasos especificados de nuestro plugin para la creación del libro:

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

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

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 necesarias mediante el comando:

$ npm install

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

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

6- Es necesario tener el repositorio remoto actualizado. Para ello podemos ejecutar 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- Construcción del libro. Para hacerlo disponemos de una tarea en el gulpfile denominada "build".

$ gulp build

10.- Previamente a crear nuestra APP en Heroku, debemos configurar una Oauth Application en Github, puesto que en el paso siguiente se pide que se introduzca por pantalla un clientID y un clientSecret para la misma. Debemos acceder al siguiente enlace y hacer click en "Register a new Application":

Generar Oauth Application

NOTA: Es importante rellenar correctamente las secciones de Homepage URL (http://localhost:8080/home) y Authorization callback URL(http:// < nombreAppHeroku > .herokuapp.com/login/github/return).

11- 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(...);
});

12- Ahora el usuario podrá ejecutar el siguiente comando y se le actualizarán los cambios en el Gitbook desplegado en Heroku:

$ 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.

$ gulp deploy-heroku

Enlaces

• Campus virtual

• Descripción de la práctica

• Publicación del paquete gitbook-start-josue-nayra

• Plugin para el despliegue en IAAS

• Plugin para el despliegue con Heroku

• Repositorio del plugin IAAS

• Repositorio de gitbook-start-josue-nayra

Referencias

• Tutorial para publicar paquetes nodejs

• Gulp

• Uso de templates

• Fyle System de Nodejs para el manejo de archivos

• Construyendo package.json

Integrantes

• Josué Toledo Castro Github personal
• María Nayra Rodríguez Pérez Github personal