Getting Started With Nucleo Schematics

This repository is a custom Indra Core Web App Schematic implementation that serves as a starting point to create components and other Angular part with our own code standards.

Nucleo Schematics

Page Module

ng generate nucleo-generator:page-module <name> <parameters>

This schematic will generate a page module with routing, store, reducer, actions, component and module.

Parameters

| Parameter Name | Description | Type | Default Value | Required | |-------------------|-------------------------------------------|-----------| :------------:| ----------| | name | Name of the page module to be generated. | string | N/A | Yes | | url | URL of the page module to be generated. |string|name|No| | routing | Flag that indicates if routing module should be generated. | boolean | true | No | | store | Flag that indicates if store and other related files should be generated. | boolean | true | No | | container | Container to be used in the page component. | string | simple | No | | project | Name of the project where page module should be generated. | string | current project | No |

Page

ng generate nucleo-generator:page <name> <parameters>

This schematic will generate a bare page component compare to the page module which generates almost every file needed.

Parameters

| Parameter Name | Description | Type | Default Value | Required | |-------------------|-------------------------------------------|-----------| :------------:| ----------| | name | Name of the page to be generated. | string | N/A | Yes | | service | Flag that indicates if service should be generated. | boolean | true | No | | container | Container to be used in the page component. | string | simple | No | | project | Name of the project where page should be generated. | string | current project | No |

Form Component

ng generate nucleo-generator:form-component <name> <parameters>

This schematic will generate a form component with form group and sample inputs to work as guide.

Parameters

| Parameter Name | Description | Type | Default Value | Required | |-------------------|-------------------------------------------|-----------| :------------:| ----------| | name | Name of the form to be generated. | string | N/A | Yes | | service | Flag that indicates if service should be generated. | boolean | true | No | | project | Name of the project where form component should be generated. | string | current project | No |

CRUD Store

ng generate nucleo-generator:crud-store <name> <parameters>

This schematic will generate a CRUD store along with actions, reducer, effects, selectors, service and module. It will also have pre-generated functions connected with the CRUD.

Parameters

| Parameter Name | Description | Type | Default Value | Required | |-------------------|-------------------------------------------|-----------| :------------:| ----------| | name | Name of the entity store to be generated. | string | N/A | Yes | | uuid | Flag that indicates if entity would have UUID. | boolean | false | No | | project | Name of the project where page module should be generated. | string | current project | No |

Blank Store

ng generate nucleo-generator:blank-store <name> <parameters>

This schematic will generate a blank store along with actions, reducer, effects, selectors, service and module. Compare to the CRUD Store, this schematic will not have pre-generated functions.

Parameters

| Parameter Name | Description | Type | Default Value | Required | |-------------------|-------------------------------------------|-----------| :------------:| ----------| | name | Name of the entity store to be generated. | string | N/A | Yes | | uuid | Flag that indicates if entity would have UUID. | boolean | false | No | | project | Name of the project where page module should be generated. | string | current project | No |