Skip to content

datosgobar/portal-andino-theme

Repository files navigation

portal-andino-theme

Repositorio de la extensión del Portal Andino de la República Argentina para CKAN. Este proyecto se encarga de modificaciones al ruteo de la aplicación web, cambios visuales a la interfaz, customización del portal, analytics y gestión de usuarios, permisos y roles, entre otros. Este repositorio no constituye el proyecto entero. El repositorio central del proyecto del Portal Andino es portal-andino

Instalación

La instalación del paquete completo está disponible como un contenedor de Docker. Seguir las instrucciones del repositorio del Portal Andino para levantar la instancia con Docker.

Desarrollo

Como alternativa a la instalación dockerizada existe la posibilidad de tener una instalación contenida en un virtualenv del sistema. Esto se puede obtener siguiendo las instrucciones de esta guia. Una vez instalado el paquete a nivel sistema, es posible linkear el proceso principal a un debbuger de python (por ej pycharm). Este metodo no es recomendado para hacer modificaciones que impacten en el manejo del servidor por parte del wsgi de apache o nginx. Para dicho caso, es necesario tener una instalación de la aplicación dockerizada y acceder al contenedor del theme para realizar el desarrollo necesario.

Esta extensión de ckan fue desarrollada siguiendo la guia de creación de extensiones.

Estructura de archivos

- ckanext
    - gobar_theme
        - js
            - archivos de js a ser importados por los distintos templates html
        - public
            - assets estáticos y públicos como imagenes y fuentes
        - styles
            - archivos css generados desde sus versiones de scss
        - templates
            - archivos de jinja renderizados por los controladores
        - actions.py # lógica de modelos de ckan, sobreescribe y/o extiende la lógica de ckan
        - config_controller.py # controlador de lógica para customización del portal
        - controller.py # controladores para la home y la api, sobreescriben y/o extienden la lógica de ckan
        - google_analytics_controller.py # controlador de google analytics, sobreescribe y/o extiende la lógica de la extensión de analytics
        - helpers.py # metodos auxiliares para renderizado de templates
        - mailer.py # metodos relacionados al envio de mails
        - package_controller.py # controlador de lógica de datasets y recursos, sobreescribe y/o extiende la lógica de ckan
        - plugin.py # archivo que registra el repositorio como extensión de ckan y declara acciones, helpers y ruteo
        - routing.py # asociación de rutas a controladores y redireccionamientos, sobreescribe y/o extiende las de ckan
        - user_controller.py # controlador de lógica de usuarios, sobreescribe y/o extiende la lógica de ckan

Uso del theme

Está disponible una guía de uso dentro de la documentación de este repositorio.

Créditos

Este repositorio es un fork de la extensión de CKAN de datos.gob.ar

Consultas sobre Andino

Andino es un portal abierto en constante desarrollo para ser usado por toda la comunidad de datos. Por eso, cuando incorporamos una nueva mejora, cuidamos mucho su compatibilidad con la versión anterior.

Como la comunidad de datos es grande, por ahora no podemos dar soporte técnico frente a modificaciones particulares del código. Sin embargo, podés contactarnos para despejar dudas.

Contacto

Te invitamos a crearnos un issue en caso de que encuentres algún bug o tengas feedback de alguna parte de portal-andino-theme.

Para todo lo demás, podés mandarnos tu comentario o consulta a [email protected].