diff --git a/README.md b/README.md index 78368bcc..ba30b375 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # los-datos-y-vos -Aplicación web del proyecto "Bring Open Data to Your School" realizado con [Eidos](http://www.aeidos.com.ar/), [Aerolab](https://aerolab.co/) y [ODI](https://theodi.org/). +Aplicación web del proyecto "_Bring Open Data to Your School_" realizado con [Eidos](http://www.aeidos.com.ar/), [Aerolab](https://aerolab.co/) y [The Open Data Institute - ODI](https://theodi.org/). ## Actividad pedagógica @@ -8,8 +8,8 @@ El proyecto _Los datos y vos_ forma parte de una actividad pedagógica diseñada ## Estructura del repositorio -* `data`: CSVs con data original del censo para construir indicadores, ids censales y lista de barrios/comunas de la CABA. -* `indicadores`: CSVs y excels con los indicadores construidos para usar en la aplicación. También hay una tabla con datos falsos +* `data`: CSVs con datos originales del censo para construir indicadores, IDs censales y lista de barrios/comunas de la CABA. +* `indicadores`: CSVs y archivos en formato excel con los indicadores construidos para usar en la aplicación. También hay una tabla con datos falsos. * `src`: Contiene el código del proyecto web para _Los datos y vos_. ## Instalación @@ -28,7 +28,7 @@ El proyecto _Los datos y vos_ forma parte de una actividad pedagógica diseñada     messagingSenderId: "messagingSenderId"   }; ``` -* Dirigirse a la solapa "Database", luego al tab "Reglas" (para permitir el acceso a la base de datos sin necesidad de estar loggeados) y modificar el código de la siguiente manera: +* Dirigirse a la solapa "Database", luego a la lengüeta "Reglas" (para permitir el acceso a la base de datos sin necesidad de estar loggeados) y modificar el código de la siguiente manera: ```javascript { @@ -40,22 +40,22 @@ El proyecto _Los datos y vos_ forma parte de una actividad pedagógica diseñada ``` * Publicar los cambios. -* Pegar la config previamente copiada en el archivo de configuración: `src/app/module.js` +* Pegar la `config` previamente copiada en el archivo de configuración: `src/app/module.js` * Seguir los pasos detallados debajo para realizar un `deploy`. ### Instrucciones para realizar el deploy -* Requisitos: tener instalado node (versión 6.9~) + [gulp](http://gulpjs.com/). -* Una vez descargado el proyecto situarse desde la terminal en la carpeta `open-data-school/los-dayos-y-vos`. +* Requisitos: tener instalado [node](https://nodejs.org/es/download/) (versión 6.9~) + [gulp](https://gulpjs.com/). +* Una vez descargado el proyecto, situarse desde la terminal en la carpeta `open-data-school/los-dayos-y-vos`. * Correr el comando `gulp production --deploy`. El mismo generará la carpeta "open-data-school/docs", que contiene los archivos estáticos compilados necesarios para que se vean los cambios en [Github pages](https://pages.github.com/). -* Luego de correr el proceso, hacer commit y push al repositorio con los archivos actualizados. +* Luego de correr el proceso, hacer `commit` y `push` al repositorio con los archivos actualizados. ### Instrucciones para levantar una instancia local -* Requisitos: tener instalado node (versión 6.9~) +* Requisitos: tener instalado [node](https://nodejs.org/es/download/) (versión 6.9~) * Una vez descargado el proyecto situarse desde la terminal en la carpeta `open-data-school/los-dayos-y-vos`. -* Correr `npm install` si se levanta la instancia local por primera vez -* Correr `npm start` para levantar la instancia local +* Correr `npm install` si se levanta la instancia local por primera vez. +* Correr `npm start` para levantar la instancia local. ## Créditos @@ -65,6 +65,6 @@ El proyecto _Los datos y vos_ forma parte de una actividad pedagógica diseñada ## Contacto -Te invitamos a [creanos un issue](https://github.com/datosgobar/los-datos-y-vos/issues/new?title=Encontre%20un%20bug%20en%20los-datos-y-vos) en caso de que encuentres algún bug o tengas feedback de alguna parte de `los-datos-y-vos`. +Te invitamos a [crearnos un issue](https://github.com/datosgobar/los-datos-y-vos/issues/new?title=Encontre%20un%20bug%20en%20los-datos-y-vos) en caso de que encuentres algún bug o tengas feedback de alguna parte de `los-datos-y-vos`. Para todo lo demás, podés mandarnos tu comentario o consulta a [datos@modernizacion.gob.ar](mailto:datos@modernizacion.gob.ar).