Esta herramienta digital forma parte del catálogo de herramientas del Banco Interamericano de Desarrollo. Puedes conocer más sobre la iniciativa del BID en code.iadb.org

• Introducción • Guía de instalación y uso • Datos abiertos • Procesamiento de datos • Lenguaje inclusivo • Acerca de DATA • Contacto • Contribuyendo • Licencia, términos y condiciones •

Introducción

Este proyecto nace bajo la premisa de unificar la data disponible sobre cursos y centros educacionales públicos de Uruguay, para ofrecerla de manera organizada, accesible y gratuita al público que desee comenzar o retomar sus estudios.

📓 Guía de instalación y uso

Estas instrucciones te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas.

📋 Pre-requisitos

Para plataforma Web.

• Node.js >=10.19.0 <=11.15.0

Este proyecto requiere alguna de las versiones especificadas. Para evitar conflictos de versiones en tu sistema operativo recomendamos utilizar algún Node Version Manager, que permite usar multiples versiones de Node en un solo equipo.

Linux y macOS

Para ambos existe nvm, que puedes instalar mediante alguno de los siguientes comandos:

  $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

  $ wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

Si tienes problemas con la instalación, dirigete a su repositorio para encontrar pistas.

Windows

Para Windows está disponible nvm-windows, cuyo instalador puedes descargar aqui. Toma en consideración que para usar este paquete debes remover versiones existentes de node y npm antes de instalar.

Para más información dirígete al proyecto

Una vez instalado, realizaremos el cambio de versión antes de agregar las demás herramientas (aplica para Linux, macOS y Windows):

  $ nvm install #versión (>=10.19.0 <=11.15.0)
  $ nvm use #versión (>=10.19.0 <=11.15.0)

• Ionic como framework base.
• Gulp para automatizar tasks.
• Bower para mantener actualizadas nuestras librerías.
• Cordova para soporte de apps nativas.

  $ npm install -g @ionic/cli gulp-cli bower cordova

🔧 Instalación

Empezaremos por clonar el repositorio:

  $ git clone https://github.com/datauy/ElijoEstudiar.git
  $ cd ElijoEstudiar/

Asegúrate de estar utilizando alguna de las versiones anteriormente especificadas:

  $ nvm use #versión

Instalamos el proyecto y actualizamos las librerías necesarias:

  $ npm install
  $ bower install

💻 Uso

Una vez instalado el proyecto corremos las tasks creadas con gulp:

  $ gulp

Por último iniciamos el servidor de desarrollo local para plataforma web:

  $ ionic serve

¡Y listo! El proyecto se iniciará en la dirección http://localhost:8100 de tu navegador predeterminado y se actualizará con cada cambio que realices.

📉 Datos abiertos

¿Qué son los datos abiertos?

El estado recoge y produce datos para cumplir con su función. Su publicación en formatos abiertos permite que sean reutilizados por el gobierno, sociedad civil, organizaciones, empresas o ciudadanos en general.

www.catalogodatos.gub.uy

Datos abiertos que utiliza la aplicación

Los datos utilizados en esta aplicación se encuentran disponibles para su reutilización a través del Catálogo Nacional de Datos Abiertos de AGESIC y otras fuentes, como datos abiertos, en formatos abiertos.

• ANEP - Centros educativos y oferta educativa

• INE - Mapas vectoriales (departamentos)

• IDE.uy - Localidades de Uruguay

Otros datos
@@ -35,51 +165,96 @@ Otros datos

Los organismos estatales del sector público recogen, producen, reproducen y difunden datos para cumplir con su función pública. Incorporar la publicación de datos públicos en formatos abiertos abre la puerta a la posibilidad de que los mismos sean reutilizados en nuevos proyectos, que puedan combinarse con otras fuentes de datos y generar nuevas aplicaciones desarrolladas por el gobierno, por la sociedad civil, organizaciones, empresas o ciudadanos en general.

📝 Procesamiento de datos

Los análisis y visualizaciones provistos por esta aplicación son realizados por DATA Uruguay. Estas operaciones están disponibles para consulta a través del código de la aplicación disponible en GitHub, así como el resto del código fuente. De cualquier manera se detallan a continuación algunas definiciones clave para el procesamiento de los datos y presentación de resultados.

👐 Lenguaje inclusivo

En la elaboración de este material se ha buscado que el lenguaje no invisibilice ni discrimine a las mujeres y a la vez que el uso reiterado de “ /o”, “/a”, “los y las”, etcétera, no dificulte la lectura. En la página 9 de la siguiente publicación se puede encontrar recomendaciones al respecto: Guía de Lenguaje Inclusivo - INMUJERES.

Acerca de DATA

Somos una organización de la sociedad civil que trabaja creando herramientas sociales para promover la participación y el debate público a través de la transparencia, datos abiertos y acceso a la información.

www.datauy.org

📧 Contacto

En caso de consultas sobre la aplicación, DATA Uruguay o contactos de prensa puede dirigirse a [email protected]. También estamos disponibles a través de nuestras cuentas de Twitter, Facebook e Instagram.

En la web de DATA puede encontrarse un kit de prensa de la organización conteniendo material gráfico, así como un kit de prensa del proyecto.

🤝 Contribuyendo

Como la mayoría de los proyectos que trabajan con datos abiertos y software libre, la retroalimentación de los usuarios es una herramienta fundamental para la mejora de los datos y su tratamiento, por lo que agradecemos e incentivamos la recepción de ideas, sugerencias o correcciones.

📄 Licencia

Disponibilidad del código como software libre

DATA Uruguay incentiva la reutilización de este software para cualquier propósito, brindándolo bajo licencia GPLv3 para que otras organizaciones, gobiernos, empresas o ciudadanos puedan sacar provecho del trabajo aquí realizado.

https://github.com/datauy/ElijoEstudiar/

Términos y condiciones

La prestación de este servicio tiene carácter gratuito para los usuarios. Los usuarios se obligan a hacer buen uso del sitio web y de sus contenidos, respetando la normativa nacional vigente, las buenas costumbres y el orden público, comprometiéndose en todos los casos a no causar daños al mismo ni a ningún tercero. A tal efecto, el Usuario se abstendrá de utilizar cualquiera de los servicios con fines o efectos ilícitos, prohibidos en los presentes Términos y condiciones, lesivos de los derechos e intereses de terceros, o que de cualquier forma puedan dañar, inutilizar, sobrecargar, deteriorar o impedir la normal utilización de los servicios, documentos y toda clase de contenidos en cualquier equipo informático o de otros Usuarios.

Para asegurarnos de que la aplicación esté acorde a las necesidades de nuestros usuarios, e intentar mejorarla utilizamos Google Analytics para recolectar información sobre cómo se utiliza. Google Analytics almacena información como qué páginas ha visitado, cuánto tiempo ha navegado en las mismas, cómo llegó a la página, qué elementos clikea e información sobre qué navegador utiliza. Su dirección IP es enmascarada (parcialmente almacenada) y la información personal sólo es reportada en forma no individualizada (agregada). No permitimos a Google usar o compartir nuestros datos analíticos para ningún propósito además de proveernos de información analítica y recomendamos que todo usuario de Google Analytics siga la misma política.

Limitación de responsabilidades

El BID no será responsable, bajo circunstancia alguna, de daño ni indemnización, moral o patrimonial; directo o indirecto; accesorio o especial; o por vía de consecuencia, previsto o imprevisto, que pudiese surgir:

i. Bajo cualquier teoría de responsabilidad, ya sea por contrato, infracción de derechos de propiedad intelectual, negligencia o bajo cualquier otra teoría; y/o

ii. A raíz del uso de la Herramienta Digital, incluyendo, pero sin limitación de potenciales defectos en la Herramienta Digital, o la pérdida o inexactitud de los datos de cualquier tipo. Lo anterior incluye los gastos o daños asociados a fallas de comunicación y/o fallas de funcionamiento de computadoras, vinculados con la utilización de la Herramienta Digital.

Este issue forma parte de un proceso de revisión de la piloto @BID-COMUNIDADES/laboratoria-code-squads de la iniciativa Código para el desarrollo

Al haber contrastado la información presentada en el repo oficial hemos encontrado los siguientes puntos a mejorar:

• Agregar el microservicio de reportes de evaluación estática de código de Sonarcloud https://sonarcloud.io/
• Agregar el badge de este servicio visible en el readme.md
• Generar reportes de calidad de código

Issue de revisión de documentación:(Este issue forma parte de un procesos de revisión de la piloto BID-COMUNIDADES/laboratoria-code-squads de la iniciativa Código para el desarrollo de EL-BID.)

Al haber contrastado la información presentadas en el repo oficial con los campos solicitados en la plantilla de readme.md https://github.com/EL-BID/Plantilla-de-repositorio/blob/master/README.md hemos encontrado los siguiente puntos a mejorar:

• Descripción y contexto: Descripción de las funcionalidades.

• Guía de usuario: (Paso a paso dirigido al usuario final sobre cómo empezar a usar la herramienta digital).

• Guía de instalación:

  1. Los requisitos del sistema operativo para la compilación (versiones específicas de librerías, 
       software de gestión de paquetes y dependencias, SDKs y compiladores, etc.).
  
  2. Las dependencias propias del proyecto, tanto externas como internas (orden de compilación 
       de sub-módulos, configuración de ubicación de librerías dinámicas, etc.). 
  
  3. Pasos específicos para la compilación del código fuente y ejecución de tests unitarios en 
       caso de que el proyecto disponga de ellos.
  

• Autores: Sección para dar créditos a los colaboradores de la herramienta.

• Licencia para el código de la herramienta: Permisos que se otorgan a terceros para reutilizar la herramienta digital. Debe especificar el tipo de licencia y hacer referencia al archivo license.txt o licencia.txt con el contenido de la licencia.

• Licencia para la documentación de la herramienta: Recomendamos el uso de las licencias creative commons para el licenciamiento de la documentación de las herramientas. La CC0-1.0, CC-BY-4.0 y CC-BY-SA-4.0 por ejemplo son licencias abiertas que se utilizan para material que no es de software, desde conjuntos de datos hasta videos. Tenga en cuenta que CC-BY-4.0 y CC-BY-SA-4.0 no deben usarse para el software.

Secciones se pueden añadir para acabar de completar la documentación

• Cómo contribuir: Sección que explica a nuevos desarrolladores el proceso para contribuir a proyectos.
• Código de conducta: El código de conducta establece las normas sociales, reglas y responsabilidades que los individuos y organizaciones deben seguir al interactuar de alguna manera con la herramienta digital o su comunidad. Es una buena práctica para crear un ambiente de respeto e inclusión en las contribuciones al proyecto. La plataforma Github premia y ayuda a los repositorios que dispongan de este archivo. Al crear CODE_OF_CONDUCT.md puedes empezar desde una plantilla sugerida por ellos. Aquí tienes una plantilla propuesta por Contributor Convenant que puedes usar para tu proyecto.
  -[ ] Insignias (badges): Las insignias (badges) pequeñas imágenes incrustadas en el README.md que especifican de una manera legible y concisa el estado de la herramienta. Existen insignias para el estado de desarrollo, el número de descargas, el versionado, sociales u otras. En este link podrás encontrar información https://shields.io/
  -[ ] Versión: Indica un listado de las versiones de las herramientas digital y las funcionalidades añadidas a cada versión.
• Reconocimientos: Reconocimientos a otras personas u organizaciones que hayan contribuido de alguna forma al proyecto