README.md

ACIJ

Type of project: website

What is it?

The Asociación Civil por la Igualdad y Justicia (ACIJ) is a well established civil society organization, recognized nationally and regionally for its work on access to justice and transparency, particularly in fiscal transparency. The organization is active in the open government and civic tech space.

The organization used to manually collect and track government data on the budget for years. They used basic tools to analyze the actual spending for their advocacy purposes, ensuring that the budget aligns with the government’s stated priorities and not misused or irresponsibly re-allocated.

As the government made budget and spending data more available, they built a “budget-monitor” tool, the Monitor Presupuestario.

This repo includes all the code for ACIJ's Monitor Presupuestario. This code lives in https://github.com/acij-ar/monitor-presupuestario/tree/redesign

What does it do?

The platform downloads a daily copy of the data from the government's open data portal. Then transforms the data to use only what we need, makes adjustments to the inflation and turns that into a database that can be consumed by the front-end. The front-end allows you to Explore or Compare the information on the budget. You can search on the different levels of the budget allocation, compare them by year, moment of the budget and get to the programatic level of the budget.

How do I use it?

You can visit monitorpresupuestario.acij.org.ar The tool will give you a quick intro on how to use it.

Credits

This was designed and developed by:

• Nela Díaz
• Ignacio Heredia
• Emanuel Zámano

Why did we build this?

Keeping track of budget for human rights is key in the work of ACIJ. They had initially built a Monitor. They needed to have a better way to navigate and show all the data available, in a way that could allow civil society organisations, researchers and even government, how the changes in the budget could affect certain programs that are key for the poeple in Argentina. Our work was supporting the redesign for a version 2.0.

About the tech

Below is the documentation to develop or deploy the Monitor Presupuestario

Estructura de carpetas

.
├── cache                       # Cache de respuestas de la API expuesta a los navegadores 
|                                 (no trackeada en git)
├── coverage                    # Carpeta auto generada al correr tests unitarios (no trackeada en git)
├── devops                      # Scripts de bash y archivos de configuración para levantar
|                                 el proyecto en el servidor productivo
├── dist                        # Archivos generados por webpack
├── public                      # Archivos públicos estáticos
└── src                         # Archivos de desarrollo del proyecto
    ├── api                     # Routers y controllers de express para la API expuesta al mundo
    ├── app                     # Routers, controllers de express, componentes de react y estilos 
    |                             para las páginas del sitio
    ├── config                  # Archivos de configuración
    └── services                # Scripts para rutinas y servicios del server

Estructura del proyecto

El proyecto consta de un servidor de Express que sirve un sitio armado usando React. Las distintas páginas del sitio se renderizan en el servidor y en el cliente se hidratan sus componentes. Los archivos del clientes se transpilan usando Webpack y Babel. Los archivos del servidor se transpilan on-the-fly por @babel/register.

La base de datos está armada sobre mysql. La db parte de datasets que son publicados por Presupuesto Abierto (del Ministerio de Economia de Argentina). Estos archivos estan guardados - a modo de mirror - en una carpeta de google-drive. Los archivos se descargan desde esta carpeta utilizando googleapis.

En el sitio web, los datos son graficados utilizando Highcarts via la dependencia react-highcharts.

Los tests unitarios están armados utilizando jest y enzyme. Se utiliza estlint como linter de JS

Configuraciones iniciales y setup de proyecto

Setup

El proyecto está hecho utilizando node. Para utilizar la version de node correspondiente al proyecto, se recomienda utilizar nvm. Una vez instalado nvm, ejecutar nvm use en la carpeta raiz del proyecto para asegurarse de utilizar la version de node correspondiente.

Una vez instalado node, se deben instalar las dependencias del proyecto via npm. Ejecutar npm install en la carpeta raiz del proyecto.

Credenciales

Hay 2 archivos de configuración necesarios para el proyecto que no están trackeados por git:

• src/config/mysql.js, utilizado para la conexión a la db de mysql
• src/services/authentication/credentials.json, utilizado para la página admin del sitio. En este caso, basta con copiar el archivo credentials-example.json ubicado en la misma carpeta y rellenado los valores correspondientes dentro del archivo.

Ambiente dev

Una vez instaladas las dependencias y configuradas las credenciales, el ambiente de desarrollo puede levantarse mediante los siguientes pasos:

• Todos los archivos .js y .css para los navegadores pueden ser generados via npm run build o npm run watch. Este ultimo comando queda ejecutandose y escuchando cambios a los archivos para volver a buildear ante cualquier cambio.
• El servidor de desarrollo puede levantarse con el comando npm run start-dev. Esto levanta un servidor en el puerto 8080.

Ambiente prod

Diferencias del ambiente productivo respecto al ambiente de desarrollo:

• Los archivos de webpack son buildeados y minificación usando el comando npm run dist.
• El servidor se levanta usando pm2 para asegurar que siempre esté levantado. Una copia del archivo de configuración de pm2 está en devops/ecosystem.config.js
• Delante del servidor de node hay un nginx que rutea entre el ambiente productivo y el ambiente de test. una copia del archivo de configuración de nginx está en devops/nginx.conf

Datasets y admin

Una vez levantado el sitio, entrar con el navegador a /admin y loguearse usando la contraseña configurada en src/services/authentication/credentials.json. Esta página sirve para actualizar los datasets descargados en el sitio y para actualizar los textos que se muestran en las distintas secciónes. Al momento de disparar una actualización de los datasets desde el admin, se ejecutan los pasos 2 a 4 de la siguiente sección "Ciclo de vida de los datos".