generator-material-app

Yet another yeoman generator for scaffolding a simple MEAN stack application using some material design elements.

This project is still under heavy development.

Features

The generator supports group based ACL's and socket.io communication with the server API.

Install

$ npm install generator-material-app

Quick Start

To quickly scaffold an application use the following commands (Answer all questions with hitting the enter key):

$ mkdir app && cd $_
$ yo material-app
$ gulp build
$ npm start

Will generate something like this: Create user dialog

Navigate to http://localhost:9001 to see the generated application where you can administer the users of your application

Add API

This will add a server API and a corresponding client route to manage your cats including test stubs and documentation:

$ yo material-app:api cat
$ yo material-app:apiroute cat
$ gulp build
$ npm start

Generate Documentation

The documentation is by now generated for server side code only:

gulp jsdoc

Run Tests

For running the generated test start the following gulp tasks

gulp unit:server
gulp unit:client

List of Generators

• Application scaffold

  • material-app (alias for material-app:app) - The directory name will be used as the application name

• Server API

  • material-app:api - Pass the name of the API items as an argument

• Client Generators

  • material-app:apiroute - Pass the name of the route as an argument
  • material-app:decorator - Pass the name of the decorator as an argument
  • material-app:directive - Pass the name of the directive as an argument
  • material-app:route - Pass the name of the route as an argument
  • material-app:controller - Pass the name of the controller as an argument
  • material-app:filter - Pass the name of the filter as an argument
  • material-app:service - Pass the name of the service as an argument
  • material-app:provider - Pass the name of the provider as an argument
  • material-app:factory - Pass the name of the factory as an argument

Purpose

This generator is suited for prototyping simple CRUD applications. The generated code is somehow following John Papa's Styleguide for Angular applications. Every generator generates a test stub for easily adding tests to your application. Note that there is not much material design in the layout yet, despite the use of the Angular Material Design components.

Used Technologies

• Node.js
• MongoDB
• Express
• mongoose
• socket.io
• Angular.js
• ui.router
• SASS
• Gulp

Screenshots

Set password dialog