generator-tmj

TMJ yeoman generator

Usage no npm install needed!

<script type="module">
  import generatorTmj from 'https://cdn.skypack.dev/generator-tmj';
</script>

README

generator-tmj

TMJ Yeoman generators of AngularJS and Laravel modules based on TMJP Web Development team approach.

Getting Started

You will need to install yeoman using npm. Be sure to have NodeJS installed before doing it so.

npm install yo -g

Locally

You need to download or clone this to a new project folder locally name it generator-tmj. Then in git shell.

git clone https://github.com/spartangian/generator-tmj.git > generator-tmj

Go to root directory of this project, then type:

npm link

That will install this generator dependencies and symlink a global module to your local file. After npm is done your good to go to your project.

Globally

Or if you don't want to download you can just install it using npm.

npm install generator-tmj -g

Usage

In your project you can create now a module.

When using this generator it is expected that you already a have angular-resource.

Core Modules

To get the core modules

Both Laravel and Angular Module

if you are in the root directory of your project you can type:

yo tmj

to include core modules in your app or to specify the location of your app.

yo tmj <path/appName>

Angular

to get only the core module of angular app

yo tmj:angular-core <path/appName>

Laravel (not yet implemented)

to get only the core module of laravel app

yo tmj:laravel-core <path/appName>
  • <path/appName> - is optional it points to the root location of your app. ( not yet implemented )

Adding Feature

Laravel (not yet implemented)

To create a feature module in laravel.

yo tmj:laravel <name>

Angular

To create a feature module in angular.

yo tmj:angular <name>

Both Laravel and Angular

To create a feature module for laravel and angular. (Currently only angular feature module is only created on this stage)

yo tmj:module <name>
  • name - required. name of the feature you will add. If the name is with spaces you should enclosed it with "this is name".

Separated Feature

TMJ generator also supports creation of separated features

Angular Module

To create a angular module file that follows the standard of TMJ.

yo tmj:angular-module <name>

Angular Controller

To create a angular controller

yo tmj:angular-controller <moduleName> --name="Name of the Controller"
  • moduleName - required. name of feature module/ angular module.
  • --name - optional. The name of the controller. If this is null the name of the controller will depend on the moduleName

Angular Factory

To create a angular factory

yo tmj:angular-factory <moduleName> --name="Name of the factory"
  • moduleName - required. name of feature module/ angular module.
  • --name - optional. The name of the factory. If this is null the name of the factory will depend on the moduleName.

Credits

John Papa Angular Style Guide TMJP Web Development Team.

License

The MIT License

Copyright (c) 2016 TMJ Philippines