martor-constructron v1.6.0
MARTOR Constructron
Módulo para crear apis y apps a partir de ficheros yaml con las definiciones y una plantilla base.
En las definiciones para apis tienen que ir: - Los ficheros de configuración propios de la aplicación que se va a contruir - Los ficheros controllers definiendo los endpoints de entrada y la lógica de negocio que se aplica en cada endpoint - Los ficheros schemas con las definiciones de las entidades de base de datos que se vayan a usar - Tipo de autenticación de usuario que se va a emplear - Otras definiciones genéricas del aplicativo, como si usa wsock, mqtt, cors, etc etc - Los ficheros test para las pruebas unitarias de la aplicación
En las definiciones de apps tiene que ir - También los ficheros de configuración y controllers con los endpoints de entrada - ... - ... - La autenticación de usuario - Los ficheros test para las pruebas unitarias de la aplicación
Con todos estos ficheros de definiciones y las plantillas que hay definidas para cada tipo de aplicación, el constructor genera todo los ficheros necesarios para tener una aplicación nodejs que se pueda arrancar y sea usable.
Instalación
$ npm i martor-constructron
Uso
Para iniciar una nueva definición de aplicación, ejecutar:
$ npx martor-constructron-init
Seguir el asistente para crear los archivos base de la nueva aplicación.
A continuación crear los ficheros de definición en sus carpetas correspondientes.
Una vez creados todos los archivos de denifición necesarios para construir la aplicación, ejecutar:
$ npx martor-constructron-build -- private/app1_defs out/app1
Y a continuación para arrancar la aplicación, ejecutar:
$ cd out/app1 && npm i && npm start
Uso de plantillas
Para usar una plantilla personalizada en la configuración contructron.template indicar la ruta relativa a la plantilla.
Autor
@_martor84 manu@martor.es
Changelog
v1.6.0
- Copy also services folder to output folder
v1.5.0
- Controllers add imports for cfg, loggers, fs and path
v1.4.2
- Fix controllers params for work on express infrastructure