generator-restmagik v0.0.2

RESTMagik FullStack Generator

Yeoman generator for creating MAGIK stack applications, using MongoDB, AngularJS, Grunt/Gulp, i18n and Koajs (the new Express) - lets you quickly set up a project following best practices.

Example project

Generated with defaults: http://restmagik-demo.herokuapp.com/.

Source code: https://github.com/knowloading/restmagik-demo

Usage

Install generator-restmagik:

npm install -g generator-restmagik

Run yo restmagik [name]

grunt serve for run development app grunt serve:dist for run distribution app.

Generators

Available generators options:

• App
  • restmagik (aka restmagik:app)
• Server
  • restmagik:endpoint
• Client
  • restmagik:route
  • restmagik:controller
  • restmagik:filter
  • restmagik:directive
  • restmagik:service
  • restmagik:provider
  • restmagik:factory
  • restmagik:decorator
• Deploy
  • restmagik:openshift
  • restmagik:heroku

API Endpoint

yo restmagik:endpoint message
[?] What will the url of your endpoint be? /api/messages

server/api/message/index.js
server/api/message/message.spec.js
server/api/message/message.controller.js
server/api/message/message.model.js  (optional)
server/api/message/message.socket.js (optional)

Route

yo restmagik:route myroute
[?] Where would you like to create this route? client/app/
[?] What will the url of your route be? /myroute

client/app/myroute/myroute.js
client/app/myroute/myroute.controller.js
client/app/myroute/myroute.controller.spec.js
client/app/myroute/myroute.html
client/app/myroute/myroute.scss

Controller

yo restmagik:controller user
[?] Where would you like to create this controller? client/app/

client/app/user/user.controller.js
client/app/user/user.controller.spec.js

Directive

yo restmagik:directive myDirective
[?] Where would you like to create this directive? client/app/
[?] Does this directive need an external html file? Yes

client/app/myDirective/myDirective.directive.js
client/app/myDirective/myDirective.directive.spec.js
client/app/myDirective/myDirective.html
client/app/myDirective/myDirective.scss

Simple directive without an html file

yo restmagik:directive simple
[?] Where would you like to create this directive? client/app/
[?] Does this directive need an external html file? No

client/app/simple/simple.directive.js
client/app/simple/simple.directive.spec.js

Filter

yo restmagik:filter myFilter
[?] Where would you like to create this filter? client/app/

client/app/myFilter/myFilter.filter.js
client/app/myFilter/myFilter.filter.spec.js

Service

yo restmagik:service myService
[?] Where would you like to create this service? client/app/

client/app/myService/myService.service.js
client/app/myService/myService.service.spec.js

You can also do yo restmagik:factory and yo restmagik:provider for other types of services.

Decorator

yo restmagik:decorator serviceName
[?] Where would you like to create this decorator? client/app/

client/app/serviceName/serviceName.decorator.js

###Openshift

Deploying to OpenShift can be done in just a few steps:

yo restmagik:openshift

A live application URL will be available in the output.

oAuth

If you're using any oAuth strategies, you must set environment variables for your selected oAuth. For example, if we're using Facebook oAuth we would do this :

rhc set-env FACEBOOK_ID=id -a my-openshift-app
rhc set-env FACEBOOK_SECRET=secret -a my-openshift-app

You will also need to set DOMAIN environment variable:

rhc config:set DOMAIN=<your-openshift-app-name>.rhcloud.com

# or (if you're using it):

rhc config:set DOMAIN=<your-custom-domain>

After you've set the required environment variables, restart the server:

rhc app-restart -a my-openshift-app

To make your deployment process easier consider using grunt-build-control.

Pushing Updates

grunt

Commit and push the resulting build, located in your dist folder:

grunt buildcontrol:openshift

Heroku

Deploying to heroku only takes a few steps.

yo restmagik:heroku

To work with your new heroku app using the command line, you will need to run any heroku commands from the dist folder.

If you're using mongoDB you will need to add a database to your app:

heroku addons:add mongohq

Your app should now be live. To view it run heroku open.

If you're using any oAuth strategies, you must set environment variables for your selected oAuth. For example, if we're using Facebook oAuth we would do this :

heroku config:set FACEBOOK_ID=id
heroku config:set FACEBOOK_SECRET=secret

You will also need to set DOMAIN environment variable:

heroku config:set DOMAIN=<your-heroku-app-name>.herokuapp.com

# or (if you're using it):

heroku config:set DOMAIN=<your-custom-domain>

To make your deployment process easier consider using grunt-build-control.

Pushing Updates

grunt

Commit and push the resulting build, located in your dist folder:

grunt buildcontrol:heroku

Bower Components

The following packages are always installed by the app generator:

• angular
• angular-cookies
• angular-mocks
• angular-resource
• angular-sanitize
• angular-scenario
• es5-shim
• font-awesome
• json3
• jquery
• lodash

These packages are installed optionally depending on your configuration:

• angular-route
• angular-ui-router
• angular-socket-io
• angular-bootstrap
• bootstrap

All of these can be updated with bower update as new versions are released.

Configuration

Yeoman generated projects can be further tweaked according to your needs by modifying project files appropriately.

A .yo-rc file is generated for helping you copy configuration across projects, and to allow you to keep track of your settings. You can change this as you see fit.

Testing

Running grunt test will run the client and server unit tests with karma and mocha.

Use grunt test:server to only run server tests.

Use grunt test:client to only run client tests.

Protractor tests

To setup protractor e2e tests, you must first run

npm run update-webdriver

Use grunt test:e2e to have protractor go through tests located in the e2e folder.

Environment Variables

Keeping your app secrets and other sensitive information in source control isn't a good idea. To have grunt launch your app with specific environment variables, add them to the git ignored environment config file: server/config/local.env.js.

Project Structure

Overview

├── client
│   ├── app                 - All of our app specific components go in here
│   ├── assets              - Custom assets: fonts, images, etc…
│   ├── components          - Our reusable components, non-specific to to our app
│
├── e2e                     - Our protractor end to end tests
│
└── server
    ├── api                 - Our apps server api
    ├── auth                - For handling authentication with different auth strategies
    ├── components          - Our reusable or app-wide components
    ├── config              - Where we do the bulk of our apps configuration
    │   └── local.env.js    - Keep our environment variables out of source control
    │   └── environment     - Configuration specific to the node environment
    └── views               - Server rendered views

An example client component in client/app

main
├── main.js                 - Routes
├── main.controller.js      - Controller for our main route
├── main.controller.spec.js - Test
├── main.html               - View
└── main.less               - Styles

An example server component in server/api

thing
├── index.js                - Routes
├── thing.controller.js     - Controller for our `thing` endpoint
├── thing.model.js          - Database model
├── thing.socket.js         - Register socket events
└── thing.spec.js           - Test