# nucleo-generator

> A schematics for Nucleo Web App Core

Latest version **0.0.2** (published 2019-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install nucleo-generator
pnpm add nucleo-generator
yarn add nucleo-generator
bun add nucleo-generator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-10-24 |
| First published | 2019-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 64.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | klayug |
| Keywords | schematics |

## Links

- npm: https://www.npmjs.com/package/nucleo-generator
- npm.io page: https://npm.io/package/nucleo-generator

## Dependencies (7)

- [jasmine](https://npm.io/package/jasmine.md) ^3.3.1
- [typescript](https://npm.io/package/typescript.md) ^3.5.3
- [@types/node](https://npm.io/package/@types/node.md) ^8.0.31
- [@types/jasmine](https://npm.io/package/@types/jasmine.md) ^3.3.9
- [@schematics/angular](https://npm.io/package/@schematics/angular.md) ^8.3.5
- [@angular-devkit/core](https://npm.io/package/@angular-devkit/core.md) ^8.3.5
- [@angular-devkit/schematics](https://npm.io/package/@angular-devkit/schematics.md) ^8.3.5

## Alternatives

- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads
- [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2019-10-24
- 0.0.1 — 2019-10-03
- 0.0.0 — 2019-10-03

## README

# 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 |

---
_Source: https://npm.io/package/nucleo-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
