Skip to content

Tutorial desarrollo de plugins ya creados

IngenieroGeomatico edited this page Aug 16, 2024 · 5 revisions

Si hemos seguido los pasos de https://github.com/IGN-CNIG/API-CNIG/wiki/Tutorial-desarrollo-del-n%C3%BAcleo-de-API-CNIG---(Cliente), ya tendremos nuestro repositorio de API-CNIG en local. A partir de este punto, seguiremos los siguientes pasos para editar el código de un plugin ya creado. Usaremos como base para el ejemplo la extensión "modal":

1./ Vamos a la ruta del plugin:

    cd API-CNIG/api-ign-js/src/plugins/modal/
  1. Instalamos las dependencias del plugin y arrancamos el servidor de desarrollo. Desde el navegador se puede acceder al desarrollo desde http://IP:Puerto/test/dev.html:
    npm i
    npm start 

3./ Dentro de la carpeta test, tenemos el archivo test.js, desde el cual se hace referencia al código mediante un "import" a api-ign-js\src\plugins\modal\src\facade\js\modal.js, archivo principal del plugin.

4./ Una vez terminado el desarrollo, validaremos el desarrollo con el comando:

    npm run check

5./ Para arreglar la mayoría de errores que se comenten durante el desarrollo, se puede ejecutar el siguiente comando:

    npm run fix

Este comando está relacionado con eslint. Si se tiene instalada la extensión en vscode (https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint), se pueden ir comprobando los errores según se va programando.

6./ El siguiente paso es compilar el plugin:

    npm run build

7./ Y por último, para comprobar que la compilación ha ido bien, se puede volver a levantar el servidor y esta vez acceder a http://IP:Puerto/test/prod.html

    npm start 

8./ Una vez comprobado que nuestro plugin se ha compilado bien, se puede proceder a realizar el Pull Request al repositorio de API-CNIG

1.INICIO
   1.1. Componentes de la API-CNIG
   1.2. Documentación y Puntos de acceso
   1.3. Primeros pasos
   1.4. Diagrama API CNIG

2. MAPA
2.1. Capas

 ■ 2.1.1. Fuentes
   • 2.1.1.1. Capas vectoriales
     + Vector
     + WFS
     + GeoJSON
     + KML
     + MVT
     + OGCAPIFeatures
     + MBTilesVector
     + GenericVector
     + MapLibre
   • 2.1.1.2. Capas ráster
     + WMS
     + WMTS
     + TMS
     + XYZ
     + OSM
     + MBTiles
     + GenericRaster
     + GeoTIFF
   • 2.1.1.3. Capas rápidas
   • 2.1.1.4. Grupo de capas

 ■ 2.1.2. Simbolización
   • 2.1.2.1. Genérica
     + Puntos
     + Líneas
     + Polígonos
   • 2.1.2.2. Básica
     + Puntos
     + Líneas
     + Polígonos
   • 2.1.2.3. Avanzada
     + Coropletas
     + Proporcional
     + Categorías
     + Estadísticos
     + Mapas de Calor
     + Cluster
     + Línea de flujo
     + Composición

 ■ 2.1.3. Filtros

2.3.-Plugins

  > Creación de plugin en cliente

  » Tutorial de creación de un plugin

2.4. Paneles

  » Creación de panel desde cero sin controles

  » Tutorial Panel de un único control

  » Tutorial Panel de un único control con más de un botón

  » Tutorial Panel con más de un control

2.5. Eventos

  » Gestión de eventos
  » Gestión de eventos en controles personalizados

    2.6. Internacionalización

    2.7. Configuración

    2.8. Acceso librerías base

3. UTILIDADES

4. PROXY

5. API REST
 5.1. Parametrización API-REST
 5.2. Base de Datos API-REST
 5.3. API REST Actions
 5.4. Servicio de correos electrónicos
 5.5. Capas rápidas

6. PARAMETRIZACIÓN VISUALIZADORES

7. SOLUCIÓN DE PROBLEMAS

8. PROCESO DE VERSIONADO

9. GUÍA DE DESARROLLO
  > Guía para el desarrollo de API-CNIG
  » Tutorial desarrollo del núcleo de API-CNIG - (Cliente)
  > Guía de desarrollo de componentes
  » Tutorial desarrollo del núcleo de API-CNIG - (Servidor)
  > Guía de desarrollo de plugins
  » Tutorial desarrollo de plugins ya creados
  » Tutorial desarrollo de nuevos plugins
  > Guía de desarrollo de visualizadores con React

  > Compilación proyecto API-CNIG

Clone this wiki locally