README

generator-vulgar

This project is currently in `alpha` and is being developed for use under the hood of vulgar-cli, a tool for generating and managing cutting-edge MEAN stack applications

Scaffolds for the Back-End

You can use $ yo vulgar to generate various back-end components:

# generate a new Mongoose model
$ yo vulgar:model

# generate a new Express route
$ yo vulgar:route

Afterwards to use the new model and route together, open app/routes.js, import your new route and add it to the RESTful API section:

// Load our API routes for the `new` component
import newRoutes from './routes/_new.router.js';

// . . .

// #### RESTful API Routes

  // Pass in our Express app and Router
  newRoutes(app, router);

You can find all possible scaffolds in the table below:

Scaffold	Usage
Model	`$ yo vulgar:model`
Route	`$ yo vulgar:route`

Angular 2 Scaffolds for the Front-End

You can use $ yo vulgar to generate various Angular 2 components:

# generate a new Angular 2 component
$ yo vulgar:ng-component

# generate a new Angular 2 directive
$ yo vulgar:ng-directive

# look at this cool new Angular 2 pipe
$ yo vulgar:ng-pipe

# and this awesome Angular 2 service
$ yo vulgar:ng-service

You can find all possible scaffolds in the table below:

Scaffold	Usage
Component	`$ yo vulgar:ng-component`
Directive	`$ yo vulgar:ng-directive`
Pipe	`$ yo vulgar:ng-pipe`
Service	`$ yo vulgar:ng-service`

Generating a Routable Component on the Front-end

You can generate a new route by with the following command (note the singular used in hedgehog):

$ yo vulgar:ng-route hedgehog

This will create a folder with a routable component (hedgehog-root.component.ts) with two sub-routes. The file structure will be as follows:

...
|-- app
|   |-- hedgehog
|   |   |-- hedgehog-detail.component.html
|   |   |-- hedgehog-detail.component.sass
|   |   |-- hedgehog-detail.component.spec.ts
|   |   |-- hedgehog-detail.component.ts
|   |   |-- hedgehog-list.component.html
|   |   |-- hedgehog-list.component.sass
|   |   |-- hedgehog-list.component.spec.ts
|   |   |-- hedgehog-list.component.ts
|   |   |-- hedgehog-root.component.spec.ts
|   |   |-- hedgehog-root.component.ts
|   |   |-- hedgehog.service.spec.ts
|   |   |-- hedgehog.service.ts
|   |-- ...
|-- app.ts
...

Afterwards to use the new route open your main app component, import hedgehog-root.component.ts and add it in the route config:

@RouteConfig([
  {path:'/hedgehog/...', name: 'HedgehogRoot', component: HedgehogRoot}
])

Visiting http://localhost:8080/hedgehog will show the hedgehog list.

Supported Options

# set the name for your routable component, bypassing the prompt
$ yo vulgar:ng-route --name anteater

# it works similarly for
$ yo vulgar:ng-component --name rhino
$ yo vulgar:ng-directive --name ostrich
$ yo vulgar:ng-pipe --name zebra
$ yo vulgar:ng-service --name giraffe

# set the path for your routable component, bypassing the prompt
$ yo vulgar:ng-route --path anteaters

# set the module for your routable component, bypassing the prompt
# note that this directory should already exist in `src/`
$ yo vulgar:ng-route --module app

# . . .
$ yo vulgar:ng-component --module app
$ yo vulgar:ng-directive --module app
$ yo vulgar:ng-pipe --module app
$ yo vulgar:ng-service --module app

# set the destination for your routable component, bypassing the prompt
# this is from the `root` of your application
$ yo vulgar:ng-route --dest src/app/todo

# . . .
$ yo vulgar:ng-component --dest src/app/todo
$ yo vulgar:ng-directive --dest src/app/todo
$ yo vulgar:ng-pipe --dest src/app/todo
$ yo vulgar:ng-service --dest src/app/shared

Acknowledgements

[Angular](https://github.com/Angular for all of their magic as well as a great scaffolding starting point based on the output of the angular-cli tool

Support, Questions, or Feedback

Contact us anytime for anything about this repo, Angular 2, or MEAN stack development in general.

Twitter: @datatype_void

enjoy -- Da5id

Looking for corporate Angular/MEAN training, want to host us, or Angular/MEAN consulting? david.r.niciforovic@gmail.com

License

MIT

Usage no npm install needed!