Readme - IGN-CNIG/API-CNIG GitHub Wiki

Es importante definir al documentación del plugin para que cualquier usuario pueda definir y usar correctamente el plugin. Para ello se usa el fichero README.md en la raíz del plugin.

El formato a seguir es:


  




APICNIG 🔌 M.plugin.Miplugin



# Descripción

...

# Dependencias

Para que el plugin funcione correctamente es necesario importar las siguientes dependencias en el documento html:

- **miplugin.ol.min.js**
- **miplugin.ol.min.css**


```html
 
 <script type="text/javascript" src="https://componentes.cnig.es/api-core/plugins/miplugin/miplugin.ol.min.js"></script>


# Uso del histórico de versiones

Existe un histórico de versiones de todos los plugins de API-CNIG en [api-ign-legacy](https://github.com/IGN-CNIG/API-CNIG/tree/master/api-ign-legacy/plugins) para hacer uso de versiones anteriores.
Ejemplo:
```html
 <link href="https://componentes.cnig.es/api-core/plugins/miplugin/miplugin-1.0.0.ol.min.css" rel="stylesheet" />
 <script type="text/javascript" src="https://componentes.cnig.es/api-core/plugins/miplugin/miplugin-1.0.0.ol.min.js"></script>



Parámetros


El constructor se inicializa con un JSON con los siguientes atributos:
  • position: Indica la posición donde se mostrará el plugin.
    • 'TL': (top left) - Arriba a la izquierda.
    • 'TR': (top right) - Arriba a la derecha (por defecto).
    • 'BL': (bottom left) - Abajo a la izquierda.
    • 'BR': (bottom right) - Abajo a la derecha. ...

API-REST

URL_API?miplugin=position*...
...
Parámetros Opciones/Descripción Disponibilidad
position TR/TL/BR/BL Base64 ✔️ | Separador ✔️

Ejemplo de uso API-REST

https://componentes.cnig.es/api-core/?miplugin=TR*...

Ejemplo de uso API-REST en base64

Para la codificación en base64 del objeto con los parámetros del plugin podemos hacer uso de la utilidad M.utils.encodeBase64. Ejemplo:

M.utils.encodeBase64(obj_params);

Ejemplo del constructor:

{
  position: "TR",
  ...
}
https://componentes.cnig.es/api-core/?miplugin=base64=...

Ejemplo de uso

const mp = new M.plugin.Miplugin({
  position: 'BL',
  ...
});

👨‍💻 Desarrollo

Para el stack de desarrollo de este componente se ha utilizado

  • NodeJS Version: 14.16
  • NPM Version: 6.14.11
  • Entorno Windows.

📐 Configuración del stack de desarrollo / Work setup

🐑 Clonar el repositorio / Cloning repository

Para descargar el repositorio en otro equipo lo clonamos:

git clone [URL del repositorio]

1️⃣ Instalación de dependencias / Install Dependencies 

npm i

2️⃣ Arranque del servidor de desarrollo / Run Application 

npm run start

📂 Estructura del código / Code scaffolding 

/
├── src 📦                  # Código fuente
├── task 📁                 # EndPoints
├── test 📁                 # Testing
├── webpack-config 📁       # Webpack configs
└── ...

📌 Metodologías y pautas de desarrollo / Methodologies and Guidelines

Metodologías y herramientas usadas en el proyecto para garantizar el Quality Assurance Code (QAC)

⛽️ Revisión e instalación de dependencias / Review and Update Dependencies

Para la revisión y actualización de las dependencias de los paquetes npm es necesario instalar de manera global el paquete/ módulo "npm-check-updates".

# Install and Run
$npm i -g npm-check-updates
$ncu
⚠️ **GitHub.com Fallback** ⚠️