Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Latest commit

 

History

History
462 lines (390 loc) · 48.8 KB

README.md

File metadata and controls

462 lines (390 loc) · 48.8 KB
Raw

@rucken/schematics

Greenkeeper badge NPM version Build Status Gitter Join the chat at telegram

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

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 admin@site15.ru
# move to created workspace
cd custom-workspace
# create frontend application in workspace
schematics @rucken/schematics:rucken-app custom-app --api=/api --author EndyKaufman --email admin@site15.ru
# 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 admin@site15.ru

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 NPM version NPM version
@nguniversal/express-engine NPM version NPM version
@ngx-meta/core NPM version NPM version
@ngx-translate/core NPM version NPM version
@rucken/core NPM version NPM version
@rucken/web NPM version NPM version
bind-observable NPM version NPM version
ngx-bind-io NPM version NPM version
ngx-bootstrap NPM version NPM version
ngx-cookie-service NPM version NPM version
ngx-dynamic-form-builder NPM version NPM version
ngx-permissions NPM version NPM version
ngx-repository NPM version NPM version

Dev dependencies

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

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 admin@site15.ru

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

Dev dependencies

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

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 admin@site15.ru

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

Dev dependencies

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

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 admin@site15.ru

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 admin@site15.ru

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 admin@site15.ru

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