Duende CG - Documentación

Definir la Aplicación

Para crear una aplicación usando el Generador de Código Duende es necesario definir las características que tendrá dicha aplicación, y esto se hace a través un objeto JSON.

Entre los elementos que se podrán definir tenemos el nombre de la aplicación, autor, puerto de ejecución, opciones del menú, entidades que participan, características de la interfaz, etc.

Estructura de la Especificación JSON para Duende

El objeto JSON que define la especificación de la aplicación objetivo tiene la siguiente estructura:

{
        "appGeneralData": {

        --> Especificaciones Generales de la aplicación <--
        (Nombre de la aplicación, autor, puerto, paquete principal, etc.)

        },

        "generalOptions": [

        --> Especificación de cada Opción General de la aplicación (array de opciones generales) <--
        (Nombre de la opción, entidad asociada, mensajes de la interfaz, subopciones de la opción, etc.)

        ],

        "dbConfig": {

        --> Datos de conexión con la Base de Datos <--
        (Nombre de la base de datos, host, usuario, contraseña, etc.)

        },

        "cssStyles": {

        --> Definición de la Paleta de Colores de la aplicación <--
        (Color del menú, botones, enlaces, etc.)

        }
}

Básicamente son tres objetos JSON y un array de objetos que agrupan las distintas características de la aplicación que se quiere generar.

appGeneralData

La clave appGeneralData es obligatoria en la especificación de la aplicación, y su valor es un objeto JSON que cuyos elementos definen las características generales de la aplicación, tales como el nombre que tendrá, el autor, la página web asociada, el puerto de ejecución, el paquete principal del código fuente, etc.

Puede encontrar más información sobre esta clave en Datos Generales de la Aplicacion.

generalOptions

La clave generalOptions es obligatoria en la especificación de la aplicación, y consiste en un array de objetos JSON, cada uno de los cuales define una "Opción General".

La aplicación objetivo contendrá un menú con varias opciones. Cada una de esas opciones conducirá a una funcionalidad concreta de la aplicación, consistente básicamente en opciones de manejo de una entidad (CRUD: crear, leer, modificar y borrar datos)

El array generalOptions contiene los datos necesarios para generar cada una de esas opciones principales de la aplicación. Vea Opciones Generales de la Aplicación para obtener más información.

dbConfig

La clave dbConfig es un objeto JSON que permite definir los datos de conexión con la base de datos de la aplicación objetivo. No es una clave requerida, por lo que no es necesaria incluirla en la especificación, pero en ese caso Duende generaría datos de conexión con la base de datos por defecto.

Más información sobre el objeto dbConfig en Configuración de la Base de Datos.

cssStyles

La clave cssStyles es un objeto JSON que permite definir distintos colores aplicables a distintos elementos de la interfaz de la aplicación objetivo. Esta clave no es requerida, y en caso de no incluirse Duende definirá una paleta de colores por defecto y se la aplicará a la aplicación generada.

Vea el tema Paleta de Colores para obtener más información.