npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gitbook-start-heroku-P8-josue-nayra

v0.1.2

Published

Plugin that lets users to deploy a gitbook in Heroku

Downloads

6

Readme

Práctica 8. Sistemas y Tecnologías Web

Passport-y-localstrategy-josue-nayra

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.


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

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-ull-es-josue-nayra para el despliegue en Heroku.

$ npm install --save gitbook-start-heroku-P8-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 .

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- Subir a Dropbox el archivo con nuestra base de datos con la siguiente estructura en formato JSON:

{
  "users":[
    {"username":"Josue", "password":"cacatua", "displayName":"Josue Toledo"},
    //...
    {"username":"Nayra", "password":"loro", "displayName":"Nayra Rodríguez"}
  ]
}

NOTA: En el caso de que por cualquier razón cambiemos nuestra base de datos en Dropbox, debemos modificar el link asociado al fichero de BD en Dropbox en nuestro archivo local '.secret.json' (sólo en el caso de que anteriormente hayamos hecho un "$gitbook-start --deploy heroku" y por lo tanto nuestro fichero ya tendrá variables de configuración, entre ellas el link de la BD.).

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

$ gitbook-start --deploy heroku  

Una vez ejecutado el comando anterior, se pedirá automáticamente por pantalla lo siguiente:

  • Token Dropbox. Introducir su token de Dropbox. En el siguiente enlace podemos obtener un token. Generar Token

  • Link Base de Datos. En la siguiente imagen se aprecia cómo se copia el enlace del fichero de BD en su Dropbox.

  • Si se requiere autenticación.

12- Realizar el despliegue. 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


Referencias


Integrantes