1.0.0 • Published 4 years ago

suscripciones-telefonia v1.0.0

Weekly downloads
4
License
GPL-3.0
Repository
github
Last release
4 years ago

Suscripciones de telefonia móvil celular

Proyecto Plataformas Web

Aplicación en NodeJS que permita leer los datos de las Suscripciones a telefonía celular móvil, publicadas por el Banco Mundial y publicar las estadísticas de un determinado país en un año específico.

Los archivos del proyecto se han realizado para una mejor manipulación y estructura de la aplicación Modelo, Vista, Controlador

Primeros pasos 🚀

Lo primero en nuestro proyecto es clonar el proyecto de Git en el directorio que deseamos.

Pre-requisitos 📋

Archivo CSV

Un archivo indispensable para la ejecución debemos descargar los datos csv a consultar de la siguiente pagina: https://datos.bancomundial.org/indicador/IT.CEL.SETS

NodeJs

NodeJs es esencial para que puedas ejecutar la aplicación.

Windows

Puedes descargar la ultima version de nodejs desde su página oficial.

Linux

  • Para distribuciones basadas en debian puedes usar los siguientes comandos :
curl -sL https://deb.nodesource.com/setup_13.x | bash -
apt-get install -y nodejs
  • Para disctribuciones basadas en arch puedes instalar usando el siguiente comando:
sudo pacman -S nodejs npm

Git

Necesitaras de git en caso de que quieras hacer cambios en la aplicacion y tener el codigo fuente a la mano.

Windows

En la página oficial podras encontrar el archivo de instalación.

Linux

  • Debian y derivadas: sudo apt install git
  • Arch y derivadas: sudo pacman -S git

Instalación

NodeJS nos permite ejecutar un proyecto de manera rápida únicamente instalando los paquetes y las dependencias que necesita nuestro proyecto de la siguiente forma.

Usando git

Primer paso

Para poder inicializar y clonar nuestro repositorio nos dirigimos a la pagina del proyecto en git y copiamos la dirrecion del repositorio

Descripcion del repositorio

Segundo paso Luego de copiar el enlace nos dirigimos a nuestra terminal y colocamos git clone seguido del enlace copiado ej:

git clone https://github.com/WilsonAG/PW-P56-P1.git

Se cargaran los archivos correspondientes para nuestro proyecto.

Tercer paso

Librerías

Al ejecutar el siguiente comando, ayudara a intalar los modulos necesarios para el correcto funcionamiento del programa desarrollado debido a que estos modulos no estan incluidos dentro del repositorio de git por uso inesesario de memoria; A demas este comando nos ayuda a verificar el funcionamiento de las librerias.

npm install

Usando npm

El proyecto tambien esta alojando en npm para una instalacion mucho mas sencilla. Para ello insertaremos en la terminal los siguientes comados:

Como comando global en el sistema:

npm install -g suscripciones-telefonia

Como dependencia para un proyecto:

npm install suscripciones-telefonia

Nota: Para ejecutar la aplicacion como dependencia de un proyecto lo hacemos de la siguiente manera: npx suscripciones-telefonia [comando] [opciones]

Modo de uso

En esta aplicacion se utiliza una invocacion por consola la cual constara de la siguiente estructura ubicandonos en el proyecto:

Si usaste el metodo de git:

node src/app.js [comando] [argumento 1] [argumento 2][argumento 3]

si instalaste por npm:

suscripciones-telefonia [comando] [argumento 1] [argumento 2][argumento 3]

Comandos 🔌

publicar:

Este comando publicará las estadísticas en una página web básica. Se requieren de tres parámetros.

  • -- file -f: Permite establecer el path del archivo CSV que contiene los datos a analizar.

  • -- country -c:Permite determinar el país a analizar a través de su código ISO 3166 ALPHA-3.

  • -- year -y: Permite especificar el año para el cual se requiere las estadísticas. Por defecto, 2018.

⚙️Ejemplo de ejecución:

Enviando año como parámetro

node src\app.js publicar -f "[direccion del archivo csv]" -c "ECU" -y 2015

suscripciones-telefonia publicar -f "[direccion del archivo csv]" -c "ECU" -y 2015

Sin año como parámetro

node src\app.js publicar -f "[direccion del archivo csv]" -c "ECU"

suscripciones-telefonia publicar -f "[direccion del archivo csv]" -c "ECU"

guardar

Este comando almacenará los resultados de las estadísticas en un archivo json. Recibe los mismos parámetros que el comando anterior, y se adiciona la siguiente opción

  • -- out -o: Establece el nombre del archivo donde se almacenará los resultados.

⚙️Ejemplo de ejecución:

node src\app.js guardar publicar -f "[direccion del archivo csv]" -c "ECU" -y 2015 -o"[direccion a guardar]"

suscripciones-telefonia guardar publicar -f "[direccion del archivo csv]" -c "ECU" -y 2015 -o"[direccion a guardar]"

Construido con 🛠️

Las siguientes herramientas fueron usadas para la creación del proyecto

  • NodeJS - entorno de ejecución para JavaScript construido con el motor de JavaScript V8 de Chrome.

  • Chalk - Permite determinar y establecer colores a la salida del terminal para visualizar resultados de mejor manera.

  • Yargs- Yargs te ayuda a crear herramientas interactivas de línea de comandos, analizando argumentos y generando una elegante interfaz de usuario.

  • Open-Utilizado para abrir cosas como URL, archivos, ejecutables. Multiplataforma. Está destinado a usarse en herramientas de línea de comandos y scripts, no en el navegador.

  • csvtojson - Nos permite convertir un formato csv a json.

Autores ✒️

Los siguientes autores son estudiantes de la Universidad Politécnica Salesiana de la Carrera de Ingeniería en Ciencias de la Computación:

Licencia 📄

Este proyecto está bajo la Licencia (GNU3) - mira el archivo LICENSE.md para detalles

Expresiones de Gratitud 🎁

  • Invita una cerveza 🍺 o un chifa 🐶 🍝 a alguien del equipo.

  • Donaciones a la cuenta RRomo :0214578545 cuenta de ahorros 🤓💰.