volokin/vocabulary repository overview

⁠Vocabulary

⁠Tabla de contenidos

Table of Contents generated with DocToc⁠

• ¿Qué es Vocabulary?⁠
• ¿Por qué Vocabulary?⁠
• Instalación del proyecto⁠
• Ejecución de los tests⁠
• Herramienta de construcción⁠
• Despliegue en un PaaS⁠
• Despliegue en PaaS con contenedores⁠
• Docker Hub⁠
• Provisionamiento con Ansible utilizando máquina virtual creada con Vagrant⁠
• Quiero saber más del proyecto⁠

⁠:thinking: ¿Qué es Vocabulary?

Vocabulary es un microservicio que permite la gestión de vocabulario a la hora de aprender una lengua.

⁠:sunglasses: ¿Por qué Vocabulary?

Cuando se aprende una nueva lengua, además de la gramática, una parte muy importante es el vocabulario. Gestionar y almacenar el vocabulario que se quiere aprender por medios convencionales es costoso e ineficiente, ya que buscar una palabra o expresión concreta u organizar el vocabulario por categorías lleva un tiempo considerable.

⁠:keyboard: Instalación del proyecto

Para poder instalar y trabajar con el proyecto, se necesita tener instalado node, npm y gulp en el equipo.

Teniéndolos instalados, nos situamos dentro del directorio raíz del proyecto e instalamos las dependencias del proyecto con la orden:

npm install .

⁠:heavy_check_mark: Ejecución de los tests

Para ejecutar los tests, situándonos en el directorio clonado, basta con ejecutar:

gulp test

De esta forma, se ejecutan los tests definidos en el directorio test/.

⁠:building_construction: Herramienta de construcción

En este proyecto se está utilizando la siguiente buildtool:

buildtool: gulpfile.js

Para tener más información sobre ésta, consulta esta página⁠.

Para obtener información sobre el gestor de procesos, utilizado por gulp, consulta esta página⁠.

⁠:cloud: Despliegue en un PaaS

Despliegue: https://vocabulary-vi.herokuapp.com/⁠

Para obtener más información, consulta esta página⁠.

⁠:package: Despliegue en PaaS con contenedores

Contenedor: https://vocabulary-vi.herokuapp.com/⁠

Contenedor: https://vocabulary-vi.azurewebsites.net/⁠

Para obtener más información sobre cómo se ha configurado el contenedor de Docker, se puede consultar esta página⁠

Para obtener más información sobre como se ha realizado el despliegue del contenedor, consulta esta página⁠.

⁠:passenger_ship: Docker Hub

URL: https://hub.docker.com/r/volokin/vocabulary⁠

Para obtener más inforación sobre el proceso seguido para subir la imagen, puedes consultar esta página⁠.

⁠:bread: Provisionamiento con Ansible utilizando máquina virtual creada con Vagrant

Provision: provisioning/playbook.yml

Para consultar información sobre la configuración de la máquina virtual con Vagrant y la subida a Vagrant Cloud, consulta esta página⁠.

Para consultar información sobre el provisionamiento con Ansible, consulta esta página⁠.

Vagrant Cloud: https://app.vagrantup.com/Volokin/boxes/Vocabulary/versions/1.0⁠

⁠:mag: Quiero saber más del proyecto

Si eres una mente curiosa y quieres saber más sobre el proyecto, redirígete a la página de documentación adicional⁠.