gitbook-start-plugin-heroku-ericlucastania

Práctica: Heroku [PLUGIN]

Descripción

Este es el repositorio del plugin. Aquí puedes encontrar dentro del archivo script.js las funcionalidades que se exportan. El initialize y el deploy.

Explicación

En este repositorio se han trabajado los módulos initialize y deploy, el método initialize es llamado cuando se ejecuta un gitbook-start -d heroku y se encarga de meter la tarea de despliegue dentro del gulp del usuario. El método también le copia en el directorio de trabajo un servidor y un archivo Procfile necesarios para el despliegue de la aplicación,así como también loguearle en heroku y crearle un repositorio en heroku. El método deploy solo hace un push al repositorio de heroku, este método es llamado cuando se ejecuta un gulp deploy-heroku

Pasos a ejecutar

1. Instala nuestro paquete de forma global

npm install -g gitbook-start-elt

2. Ejecuta el binario para el render del template

Tienes la opción de crear el repositorio o la opción de no crearlo:

Crear repositorio

• Si quieres que te cree un repositorio en Github tienes que poner la opción --repo

  gitbook-start --dir Carpeta --repo

Cuando ejecutes el paso anterior si no es la primera vez que lo haces te pedirá el usuario y contraseña de github.Si introduces los datos correctamente te pedirá que introduzcas el nombre que quieres ponerle al repo, Ahora se desplegará el libro en github:

Ejemplo de uso:

Una vez que se te creado el repo ya puedes trabajar en él,ya no tendrás que poner más el usuario y contraseña gracias a que se te generó un token para evitar que cada vez que quieras crear un repo te pida tus credenciales. El token que se genera se guarda en el ./gitbook-start/config.json un lugar seguro para que no pueda acceder nadie que no seas tu.

No Crear repositorio

• Si no quieres que se te cree el repositorio en Github simplemente ejecuta la siguiente opción

  gitbook-start --dir Carpeta !!Si no ejecutas el --dir se creará una carpeta con tu nombre de usuario

3. Entra en la carpeta

cd Carpeta

PLUGINS

1. Instala el plugin forma global

npm install -g gitbook-start-plugin-heroku-ericlucastania

2. Ejecuta el plugin que desees, asegúrate de estar dentro de la carpeta

gitbook-start -d heroku !! También puedes usar la opción --deploy

• Te pedirá un token, puedes generarlo ejecutando heroku auth:token o bien usar uno ya generado.
• Se te solicitará el nombre que tendrá tu aplicación en Heroku.
• Te preguntará si deseas pedir autentificación para que sólo los usuarios de tu organización puedan leer el libro.
  • Tienes diferentes opciones:
    • Si quieres que solo los usuarios de la organización puedan acceder al libro tendras que poner la opción 's' o 'S' o simplemente darle a enter
    • Si quieres que cualquiera pueda acceder al libro,tendrás que poner la opción 'n' o 'N'

3. Generando aplicación

• Cambiar en el archivo datos_dropbox.json los datos creándote una nueva app en Dropbox en el siguiente enlace Enlace a Create App

• A continuación aparecen tres pasos para crear la app,cuando los hayas hecho dale a el botón crear app y listo

• Una vez creada la aplicación vete a donde pone Generate token y clica sobre él,el token que se te genera lo copias y lo pegas en el archivo "datos_dropbox" sustituyendo el token que está por el que acabas de copiar

4. Ejecuta el gulp creado

gulp deploy-heroku

Explicación

Cuando se ejecuta el gitbook-start -d PLUGIN se te lanzará el initialize del plugin, el initialize crea una tarea en el gulp para realizar el deploy. Además de guardarte el paquete elegido en el package.json.

Corrección

Usamos la Api de heroku para conectarnos a la aplicación

     const Heroku = require('heroku-client');
            var tokenHeroku = readlineSync.question('Introduzca el token para conectarte: ');
            try{
              var heroku = new Heroku({ token: tokenHeroku });
            }
            catch(err){
              console.error("Error al conectarte por token");
            }

Opciones

gitbook-start [OPTIONS]
    --dir nombre del directorio a crear  gitbook-star --dir miDirectorio
    -a autor del libro a crear node gitbook-star -a AutorDelLibro
    -e email del autor del libro node gitbook-star -e [e-mail]
    -r repositorio github contra el que se va a trabajar -r nameRepo
    -v muestra la version del paquete gitbook-start -v
    -h muestra ayuda sobre las opciones disponibles
    --repo opción que te permite crear un repositorio en Github

Enlaces interesantes

• NPM
• Repositorio de la práctica
• Descripción de la tarea campus
• PLUGIN
• NPM PLUGIN

Componentes del grupo de trabajo

• Eric Ramos
• Lucas Ruiz
• Tania González