From 3fcd4d51d6c23aded63f71c114a59d15daf3540d Mon Sep 17 00:00:00 2001 From: DIAZ RUIZ ANA KAREN Date: Tue, 4 Aug 2020 12:21:31 -0500 Subject: [PATCH] Update README.md --- README.md | 60 +++++++++++++++++++++++++------------------------------ 1 file changed, 27 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index d96cd94..f861ae4 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,35 @@ -# Sitio de Información de los Objetivos de Desarrollo Sostenible, México +# Sitio de Información de los Objetivos de Desarrollo Sostenible, México -La adopción de la Agenda 2030 para el Desarrollo Sostenible en México ha implicado la puesta en marcha de una plataforma para el seguimiento y monitoreo de los indicadores de los Objetivos de Desarrollo Sostenible, la cual está diseñada en una arquitectura bajo el modelo MVC (Modelo Vista Controlador) que permite reutilizar el código y reduce el uso del código del servidor. -Dentro de la capa del “modelo” se utiliza un servicio RESTful (API) para obtener los datos. -En la capa “vista” se utiliza HTML5, CSS3 y Framework Bootstrap. -Finalmente, la capa “controlador” usa Framework Angular JS. -Estas características permiten compartirse como código multi-plataforma +La adopción de la Agenda 2030 para el Desarrollo Sostenible en México ha implicado la puesta en marcha de una plataforma para el seguimiento y monitoreo de los indicadores de los Objetivos de Desarrollo Sostenible, la cual está diseñada en una arquitectura bajo el modelo MVC (Modelo Vista Controlador) que permite reutilizar el código y reduce el uso del código del servidor. +Dentro de la capa del “modelo†se utiliza un servicio RESTful (API) para obtener los datos. +En la capa “vista†se utiliza HTML5, CSS3 y Framework Bootstrap. +Finalmente, la capa “controlador†usa Framework Angular JS. +Estas características permiten compartirse como código multi-plataforma ## Iniciando ### Requisitos -Tener un servidor de aplicaciones y una conexión a internet. +Tener un servidor de aplicaciones y una conexión a internet. -### Instalación +### Instalación -Genera una carpeta llamada “ods” en el servidor de aplicaciones disponible, por ejemplo, si tu servidor de aplicaciones es Apache bajo el sistema operativo Linux, entonces genera la carpeta “ods” debajo de la ruta “\var\www\html”. -En esta carpeta copia el código fuente del Sistema de Información de los ODS de México. +Genera una carpeta llamada “ods†en el servidor de aplicaciones disponible, por ejemplo, si tu servidor de aplicaciones es Apache bajo el sistema operativo Linux, entonces genera la carpeta “ods†debajo de la ruta “\var\www\htmlâ€. +En esta carpeta copia el código fuente del Sistema de Información de los ODS de México. ## Realizando las pruebas -Asegúrate que el servidor de aplicaciones se está ejecutando y desde ahí, mediante el uso de un navegador (Chrome, Explorer, etc.) accede a la liga "http://localhost/ods/index.html". -A continuación, dar clic en la liga de “indicadores”, y posteriormente sobre el indicador 3.1.1 del objetivo 3. -Este indicador mostrará sus tres elementos: Indicador, Metadato y Datos para el cálculo, asimismo, en el elemento Indicador se visualizarán los datos en Mapa, Gráfica y Datos,como se ve en la siguiente imagen: +Asegúrate que el servidor de aplicaciones se está ejecutando y desde ahí, mediante el uso de un navegador (Chrome, Explorer, etc.) accede a la liga "http://localhost/ods/index.html". +A continuación, dar clic en la liga de “indicadoresâ€, y posteriormente sobre el indicador 3.1.1 del objetivo 3. +Este indicador mostrará sus tres elementos: Indicador, Metadato y Datos para el cálculo, asimismo, en el elemento Indicador se visualizarán los datos en Mapa, Gráfica y Datos,como se ve en la siguiente imagen: ## ![elementos del indicador](/docs/img/ejem_readme_eleind.png) -## Servicio RESTful (API) para los datos (series estadísticas y ficha de metadatos) de los ODS de México - -El servicio RESTful (API), es el encargado de proveer los datos y metadatos de los indicadores de los ODS de México, el cual los devuelve en [estructuras JSON](docs/09_estructuras_JSON.pdf). -El módulo que contiene las llamadas al servicio RESTful es "app/js/AppService.js". - -## Servicio del Mapa Digital de México (API) - -Para utilizar el servicio del Mapa Digital de México (API), vea el instructivo INSTRUCTIVO MDM ; o bien, coloque el atributo VisualizaMapa_atr con valor "N”, el cual regresa el servicio RESTful(API) en el objeto JSON de Atributos (docs/09_estructuras_JSON.pdf). -NOTA: Si requiere utilizar otro software para el manejo de mapas, tienes que eliminar la URL del API del Mapa Digital de México, al que se hace referencia dentro del código, además de las carpetas “mapa” y “json”, así como la de los archivos “mapa*.html” y “mapa*.js”, para dar lugar a la conexión al nuevo mapa. +## Servicio RESTful (API) para los datos (series estadísticas y ficha de metadatos) de los ODS de México +El servicio RESTful (API), es el encargado de proveer los datos y metadatos de los indicadores de los ODS de México, el cual los devuelve en [estructuras JSON](docs/09_estructuras_JSON.pdf). +El módulo que contiene las llamadas al servicio RESTful es "app/js/AppService.js". ## Construido con: @@ -45,26 +39,26 @@ NOTA: Si requiere utilizar otro software para el manejo de mapas, tienes que eli * D3 * Angular JS -## Documentación adicional -* [Análisis del negocio](docs/01_analisis_negocio.pdf) - Antecedentes y descripción de la plataforma. -* [Ficha técnica](docs/03_ficha_tecnica.pdf) - Objetivo, diagrama contextual y características técnicas de la plataforma. -* [Estructura de carpetas](docs/05_estructura_carpetas.pdf) - Organización de las carpetas del código fuente. -* [Patrones de diseño](docs/06_patrones_diseno.pdf) - Arquitectura basada en patrones de diseño MVC. -* [Diagramas de clase](docs/07_diagramas_clases.pdf) - 13 diagramas de clase que muestran la estructura del código fuente. +## Documentación adicional +* [Análisis del negocio](docs/01_analisis_negocio.pdf) - Antecedentes y descripción de la plataforma. +* [Ficha técnica](docs/03_ficha_tecnica.pdf) - Objetivo, diagrama contextual y características técnicas de la plataforma. +* [Estructura de carpetas](docs/05_estructura_carpetas.pdf) - Organización de las carpetas del código fuente. +* [Patrones de diseño](docs/06_patrones_diseno.pdf) - Arquitectura basada en patrones de diseño MVC. +* [Diagramas de clase](docs/07_diagramas_clases.pdf) - 13 diagramas de clase que muestran la estructura del código fuente. * [Tipos de tabulados](docs/08_tipos_tabulados.pdf) - Especificaciones de los tipos de tabulados que utiliza la plataforma. * [Estructuras de archivos JSON](docs/09_estructuras_JSON.pdf) - Especificaciones de las estructuras de los archivos JSON utilizados. -* [Plataforma de desarrollo](docs/10_plataforma_desarrollo.pdf) - Especificaciones de sistemas operativos, servidor de aplicaciones, lenguajes de programación y servicios utilizados. -* [Matriz de riesgos](docs/11_matriz_riesgos.pdf) - Análisis de riesgos, causas y efectos. +* [Plataforma de desarrollo](docs/10_plataforma_desarrollo.pdf) - Especificaciones de sistemas operativos, servidor de aplicaciones, lenguajes de programación y servicios utilizados. +* [Matriz de riesgos](docs/11_matriz_riesgos.pdf) - Análisis de riesgos, causas y efectos. * [Manual de usuario](docs/12_manual_usuario.pdf) - Manual para uso del SIODS. ## Versiones -La versión disponible del Sistema de Información de los Objetivos de Desarrollo Sostenible de México es la 2.4.0. +La versión disponible del Sistema de Información de los Objetivos de Desarrollo Sostenible de México es la 2.4.0. ## Autor -Instituto Nacional de Estadística y Geografía (INEGI), México [www.inegi.org.mx](http://www.inegi.org.mx). +Instituto Nacional de Estadística y Geografía (INEGI), México [www.inegi.org.mx](http://www.inegi.org.mx). ## Licencia -Este proyecto está bajo la licencia de código abierto del Instituto Nacional de Estadística y Geografía, para más detalles ver [licencia](http://www.agenda2030.mx/docs/doctos/system/Licencia_codigo_abierto_ES.pdf) +Este proyecto está bajo la licencia de código abierto del Instituto Nacional de Estadística y Geografía, para más detalles ver [licencia](http://www.agenda2030.mx/docs/doctos/system/Licencia_codigo_abierto_ES.pdf) -- GitLab