generator-ajs-component

Yeoman generator

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-ajs-component from npm, run:

npm install -g generator-ajs-component

Finally, initiate the generator:

yo ajs-component

To start the project just run:

gulp

That's it.... gulp.

Cool Stuff It Can Do

This generator give you an angular project that uses gulp to handle compiling and building. The gulp file can generate your major files for you and inject them into your project.

gulp generate:directives --name pillow

The above code will generate the following in the directives folder:

...
|-directives
    |-pillow
        |-pillow.scss
        |-pillow.js
        |-pillow.html
...

The gulp file can generate controllers and directives so far but support for services and filters will be coming soon. The folder structure is component driven so if your project is made up of individual functional pieces then this generator will work for you. The folder structure will resemble the following:

-Project Folder
  |- gulpfile.js
  |- other
  |- config
  |- files
  |-.templates (Don't Need to worry about this file. The gulp uses its contents to generate your files)
  |--public
      |-assets
          |-fonts
          |-images
      |-styles
          |-scss
              |-partials
      |-scripts
          |-controllers
          |-directives
          |-services
          |-filters
          |-vendors
      |-views
      |-index.html

License

MIT