@rucken/schematics

A schematics collections for generate source files for Angular7+ and NestJS application based on Rucken template

• Install
• Usage
• Available generators

Install

npm install -g @angular-devkit/schematics-cli
npm install -g @rucken/schematics

Usage

# create workspace
schematics @rucken/schematics:workspace custom-workspace --author EndyKaufman --email [email protected]
# move to created workspace
cd custom-workspace
# create frontend application in workspace
schematics @rucken/schematics:rucken-app custom-app --api=/api --author EndyKaufman --email [email protected]
# install dependencies
npm i
# start dev server for frontend application
ng serve custom-app

Available generators

• Rucken app - Frontend application generator on Angular7+ with Bootstrap3, based on the Rucken template
• Rucken app ionic - Mobile frontend generator application on Angular7+ with Ionic4, based on the Rucken template
• Rucken app nestjs - REST generator backend applications on NestJS with TypeORM, based on the Rucken template
• Rucken entity - Model generator for frontend application, based on the Rucken template
• Rucken entity ionic - The generator of the main components for editing data on the model and for a mobile frontend application on Angular7+ with Ionic4, based on the Rucken template
• Rucken entity ionic to app - Binding components for editing an entity to a mobile frontend application on Angular7+ with Ionic4, based on the Rucken template
• Rucken entity nestjs - The generator of the entity, the DTO, the service and the controller, for editing the entity data for the backend of the application on NestJS with TypeORM, based on the Rucken template
• Rucken entity web - The generator of the main components for editing data on the model and for the frontend application on Angular7+ with Bootstrap3, based on the Rucken template
• Rucken entity web to app - Binding of components for editing an entity to a frontend application on Angular7+ with Bootstrap3, based on the Rucken template
• Rucken lib - Frontend library generator, based on the Rucken template
• Rucken lib nestjs - Backend library generator on NestJS, based on the Rucken template
• Rucken lib nestjs to app - Linking the library to the backend application on NestJS, based on the Rucken template
• Rucken lib to app - Linking the library to the frontend application on Angular7+, based on the Rucken template
• Workspace - Workspace generator, based on the Rucken template

Rucken app

Frontend application generator on Angular7+ with Bootstrap3, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-app custom-app --api=/api --author EndyKaufman --email [email protected]

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the application. | {"$source":"argv","index":0} | | org | {string} | The name of organization. | none | | api | {string} | The backend api address (/api, http://host.com/api, https://api.host.com). | none | | author | {string} | Author name. | none | | email | {string} | Author email name. | none |

Dependencies

| Name | Used | Current | | ------ | ------ | ------ | | @angular/core | | | | @nguniversal/express-engine | | | | @ngx-meta/core | | | | @ngx-translate/core | | | | @rucken/core | | | | @rucken/web | | | | bind-observable | | | | ngx-bind-io | | | | ngx-bootstrap | | | | ngx-cookie-service | | | | ngx-dynamic-form-builder | | | | ngx-permissions | | | | ngx-repository | | |

Dev dependencies

| Name | Used | Current | | ------ | ------ | ------ | | @angular-devkit/build-angular | | | | @angular/cli | | | | @angular/compiler-cli | | | | @compodoc/compodoc | | | | @rucken/cli | | | | domino | | | | ts-node | | | | tslib | | | | typescript | | | | webpack-cli | | |

See code: src/schematics/rucken-app/index.ts

Rucken app ionic

Mobile frontend generator application on Angular7+ with Ionic4, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-app-ionic custom-app-ionic --api=/api --author EndyKaufman --email [email protected]

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the application. | {"$source":"argv","index":0} | | org | {string} | The name of organization. | none | | api | {string} | The backend api address (/api, http://host.com/api, https://api.host.com). | none | | author | {string} | Author name. | none | | email | {string} | Author email name. | none |

Dependencies

| Name | Used | Current | | ------ | ------ | ------ | | @angular/core | | | | @capacitor/android | | | | @capacitor/core | | | | @ionic-native/core | | | | @ionic-native/http | | | | @ionic-native/splash-screen | | | | @ionic-native/status-bar | | | | @ionic/angular | | | | @ionic/storage | | | | @nguniversal/express-engine | | | | @ngx-meta/core | | | | @rucken/core | | | | @rucken/ionic | | | | bind-observable | | | | cordova-android | | | | cordova-plugin-advanced-http | | | | cordova-plugin-device | | | | cordova-plugin-file | | | | cordova-plugin-ionic-keyboard | | | | cordova-plugin-ionic-webview | | | | cordova-plugin-splashscreen | | | | cordova-plugin-statusbar | | | | cordova-plugin-whitelist | | | | cordova-sqlite-storage | | | | core-js | | | | ngx-bind-io | | | | ngx-cookie-service | | | | ngx-dynamic-form-builder | | | | ngx-remote-config | | | | ngx-repository | | | | rxjs | | |

Dev dependencies

| Name | Used | Current | | ------ | ------ | ------ | | @angular-devkit/build-angular | | | | @angular-devkit/core | | | | @angular/compiler | | | | @capacitor/cli | | | | @ionic/ng-toolkit | | | | @ionic/schematics-angular | | | | @nrwl/builders | | | | @rucken/cli | | | | ng-packagr | | | | ts-node | | | | tslib | | | | typescript | | |

See code: src/schematics/rucken-app-ionic/index.ts

Rucken app nestjs

REST generator backend applications on NestJS with TypeORM, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-app-nestjs custom-app-nestjs --author EndyKaufman --email [email protected]

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the application. | {"$source":"argv","index":0} | | org | {string} | The name of organization. | none | | author | {string} | Author name. | none | | email | {string} | Author email name. | none |

Dependencies

| Name | Used | Current | | ------ | ------ | ------ | | @angular/core | | | | @angular-devkit/architect | | | | @angular-devkit/core | | | | @nestjs/common | | | | @nestjs/core | | | | @nestjs/passport | | | | @nestjs/swagger | | | | @nestjs/typeorm | | | | @nrwl/nx | | | | @rucken/auth-nestjs | | | | @rucken/core-nestjs | | | | @types/passport-facebook-token | | | | @types/passport-local | | | | class-transformer | | | | class-validator | | | | connection-string | | | | fastify-formbody | | | | jsonwebtoken | | | | node-django-hashers | | | | passport | | | | passport-facebook-token | | | | passport-google-plus-token | | | | passport-http-bearer | | | | passport-jwt | | | | passport-local | | | | pg | | | | rxjs | | | | sqlite3 | | | | ts-node | | | | tsconfig-paths | | | | typeorm | | | | typescript | | | | cross-env | | |

Dev dependencies

| Name | Used | Current | | ------ | ------ | ------ | | @angular-devkit/build-angular | | | | @angular/cli | | | | @angular/compiler | | | | @nestjs/schematics | | | | @nestjs/testing | | | | @nrwl/builders | | | | @nrwl/schematics | | | | @rucken/cli | | | | nodemon | | | | pm2 | | | | webpack | | | | webpack-cli | | | | webpack-node-externals | | |

See code: src/schematics/rucken-app-nestjs/index.ts

Rucken entity

Model generator for frontend application, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-entity custom-entity --org custom-org --lib custom-lib

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the entity. | {"$source":"argv","index":0} | | lib | {string} | The name of the library. | none | | org | {string} | The name of organization. | none |

See code: src/schematics/rucken-entity/index.ts

Rucken entity ionic

The generator of the main components for editing data on the model and for a mobile frontend application on Angular7+ with Ionic4, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-entity-ionic custom-entity --org custom-org --lib custom-lib-ionic --entitiesLib custom-lib

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the entity. | {"$source":"argv","index":0} | | lib | {string} | The name of the library. | none | | entitiesLib | {string} | The name of the library with entities. | none | | org | {string} | The name of organization. | none |

See code: src/schematics/rucken-entity-ionic/index.ts

Rucken entity ionic to app

Binding components for editing an entity to a mobile frontend application on Angular7+ with Ionic4, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-entity-ionic-to-app custom-entity --lib custom-lib-ionic --org custom-org --app custom-app-ionic --entitiesLib custom-lib

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the entity. | {"$source":"argv","index":0} | | lib | {string} | The name of the library. | none | | entitiesLib | {string} | The name of the library with entities. | none | | org | {string} | The name of organization. | none | | app | {string} | The name of application. | none |

See code: src/schematics/rucken-entity-ionic-to-app/index.ts

Rucken entity nestjs

The generator of the entity, the DTO, the service and the controller, for editing the entity data for the backend of the application on NestJS with TypeORM, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-entity-nestjs custom-entity --org custom-org --lib custom-lib-nestjs --timestamp 1553957529598

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the entity. | {"$source":"argv","index":0} | | lib | {string} | The name of the library. | none | | org | {string} | The name of organization. | none | | timestamp | {number} | Timestamp used in migrations. | none |

See code: src/schematics/rucken-entity-nestjs/index.ts

Rucken entity web

The generator of the main components for editing data on the model and for the frontend application on Angular7+ with Bootstrap3, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-entity-web custom-entity --org custom-org --lib custom-lib-web --entitiesLib custom-lib

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the entity. | {"$source":"argv","index":0} | | lib | {string} | The name of the library. | none | | entitiesLib | {string} | The name of the library with entities. | none | | org | {string} | The name of organization. | none |

See code: src/schematics/rucken-entity-web/index.ts

Rucken entity web to app

Binding of components for editing an entity to a frontend application on Angular7+ with Bootstrap3, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-entity-web-to-app custom-entity --lib custom-lib-web --org custom-org --app custom-app --entitiesLib custom-lib

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the entity. | {"$source":"argv","index":0} | | lib | {string} | The name of the library. | none | | entitiesLib | {string} | The name of the library with entities. | none | | org | {string} | The name of organization. | none | | app | {string} | The name of application. | none |

See code: src/schematics/rucken-entity-web-to-app/index.ts

Rucken lib

Frontend library generator, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-lib custom-lib-web --org custom-org --author EndyKaufman --email [email protected]

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the library. | {"$source":"argv","index":0} | | org | {string} | The name of organization. | none | | author | {string} | Author name. | none | | email | {string} | Author email name. | none |

See code: src/schematics/rucken-lib/index.ts

Rucken lib nestjs

Backend library generator on NestJS, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-lib-nestjs custom-lib-nestjs --org custom-org --author EndyKaufman --email [email protected]

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the library. | {"$source":"argv","index":0} | | org | {string} | The name of organization. | none | | author | {string} | Author name. | none | | email | {string} | Author email name. | none |

See code: src/schematics/rucken-lib-nestjs/index.ts

Rucken lib nestjs to app

Linking the library to the backend application on NestJS, based on the Rucken template

Example:

schematics @rucken/schematics:rucken-lib-nestjs-to-app custom-lib-nestjs --org custom-org --app custom-app-nestjs

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the library. | {"$source":"argv","index":0} | | org | {string} | The name of organization. | none | | app | {string} | The name of application. | none |

See code: src/schematics/rucken-lib-nestjs-to-app/index.ts

Rucken lib to app

Linking the library to the frontend application on Angular7+, based on the Rucken template

Examples:

schematics @rucken/schematics:rucken-lib-to-app custom-lib --org custom-org --app custom-app
schematics @rucken/schematics:rucken-lib-to-app custom-lib-web --org custom-org --app custom-app
schematics @rucken/schematics:rucken-lib-to-app custom-lib --org custom-org --app custom-app-ionic
schematics @rucken/schematics:rucken-lib-to-app custom-lib-ionic --org custom-org --app custom-app-ionic

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the library. | {"$source":"argv","index":0} | | org | {string} | The name of organization. | none | | app | {string} | The name of application. | none |

See code: src/schematics/rucken-lib-to-app/index.ts

Workspace

Workspace generator, based on the Rucken template

Example:

schematics @rucken/schematics:workspace custom-workspace --author EndyKaufman --email [email protected]

Parameters

| Name | Type | Description | Default | |------|:----:|------------:|--------:| | name | {string} | The name of the workspace. | {"$source":"argv","index":0} | | author | {string} | Author name. | none | | email | {string} | Author email name. | none |

See code: src/schematics/workspace/index.ts

License

MIT