Appearance

README: Instalación y Construcción del Proyecto ​

Este documento describe los pasos necesarios para instalar y construir el proyecto rosepetal-node-red-contrib.

Requisitos Previos ​

Antes de comenzar, asegúrate de tener instalados los siguientes componentes:

  • Node.js: versión 18 o superior
  • npm: administrador de paquetes de Node.js

Pasos de Instalación ​

  1. Clona el repositorio del proyecto:

    bash
    git clone <URL-del-repositorio>
cd <nombre-del-repositorio>

  2. Instala las dependencias del proyecto:

    bash
    npm install

Construcción del Proyecto ​

Para construir el proyecto, ejecuta el siguiente comando:

bash
npm run build

Esto generará los recursos con Vite y los hará accesibles desde Node-RED Dashboard 2.

Comandos Adicionales ​

Copiar Recursos ​

Esto hace accesibles los recursos desde Node-RED Dashboard 2 y se ejecuta automáticamente al hacer un build:

bash
npm run copy-resources

Limpiar Recursos ​

Para limpiar los recursos generados, ejecuta:

bash
npm run clean

Creación de un Nuevo Nodo ​

Para crear un nuevo nodo, sigue estos pasos:

  1. Añade la definición del nuevo nodo en la sección node-red del archivo package.json. Por ejemplo, para un nodo llamado nuevo-nodo, la sección debe verse así:

    json
    "node-red": {
  "version": ">=3.0.0",
  "nodes": {
    "nuevo-nodo": "ruta/al/nuevo-nodo/nuevo-nodo.js"
  }
}

  2. Si el nuevo nodo es un widget para el dashboard, también debes añadirlo en la sección node-red-dashboard-2. Por ejemplo:

    json
    "node-red-dashboard-2": {
  "version": "1.0.0",
  "widgets": {
    "nuevo-widget": {
      "output": "nuevo-widget.umd.js",
      "component": "NuevoWidgetComponent"
    }
  }
}

  3. Ejecuta el comando de construcción para asegurarte de que los cambios se reflejen correctamente:

    bash
    npm run build

Estructura del Proyecto ​

El proyecto está organizado de la siguiente manera:

.
├── rosepetal-dashboard/       # Widgets y nodos personalizados
│   ├── ui-fabric-canvas/      # Componente UI Fabric Canvas
│   ├── ui-line-setter/        # Componente UI Line Setter
│   ├── ui-sessionstatus/      # Componente UI Session Status
│   └── ...                    # Otros componentes y nodos
├── resources/                 # Recursos adicionales
├── package.json               # Archivo de configuración del proyecto
└── vite.config.js             # Configuración de Vite

Notas ​

  • Asegúrate de estar en el directorio raíz del proyecto antes de ejecutar los comandos.
  • Si encuentras algún problema, verifica que tu versión de Node.js sea compatible (>= 18).
  • Este proyecto utiliza workspaces de npm para manejar múltiples paquetes.

¡Disfruta utilizando rosepetal-node-red-contrib!