Ember BigProject

Create a sensible and extensible Ember project structure for big projects ;)

Installation

Add this line to your application's Gemfile:

gem 'ember-big_project'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ember-big_project

Usage

Important!!

This bootstrap generators expects that you have set up your Ember project using ember:bootstrap or similar generator. Before you execute ember_proj:bootstrap, please make sure you have comitted you project to version control, so you go revert in case you need to.

Command:

$ rails g ember_proj:bootstrap

Help!? (see list of options available):

$ rails g ember_proj:bootstrap --help

Example: add ember-auth basic authentication and emblem templating ;)

$ rails g ember_proj:bootstrap --auth ember-auth --emblem

Ember app structure

Proposed (recommended) app structure for large Ember app.

  - application.js

  + app
    - app_loader.js
    + authentication
      + mixins  

    + config
      + locales
      - app.js
      - locale.js
      - logging.js
      - display.js

    + controllers
      + _mixins
      + users
        - user_controller
        - users_controller
      - session_controller

    + helpers
    + lib  
    + mixins

    + models
      + extensions
      + mixins  
      - user.js  

    + views
      + extensions
      + mixins
      - new_user_view.js
      - user_view.js
      - users_view.js

    + routes
      + helpers
      + mixins
      + shortcuts
      - user_router.js
      - index_router.js

    + state_managers
    + templates
    - authentication.js
    - config.js
    - controllers.js
    - helpers.js
    - lib.js
    - mixins.js
    - models.js
    - views.js
    - routes.js
    - state_managers.js
    - templates.js

application.js

# application.js

#= require modernizr
#= require jquery
#= require handlebars
#= require ruby
#= require ember
#= require ember-data
#= require ember-data-validations
#= require ember-formBuilder
#= require bootstrap

#= require app/app_loader

#= require rails.validations
#= require rails.validations.ember

window.App = Ember.Application.create LOG_TRANSITIONS: true

# Defer App readiness until it should be advanced for either
# testing or production.
App.deferReadiness()

app/app_loader_.js

Responsible for loading all the Ember app files

# app/app_loader_.js

#= require_self

#= require_tree lib
#= require_tree mixins
#= require_tree helpers
#= require_tree config

#= require store
#= require models
#= require controllers
#= require views

#= require state_managers
#= require authentication
#= require routes

models.js

Index files such as 'models.js' are useful in order to quickly change the load order of files or add/remove files to be included in the app ;)

You will likley have specific mixins for models, that should be loaded before the models they are mixed into - the reason for this pattern.

You can then make custom extensions to your models, after they have applied whatever mixins they need or directly extend built-in Ember classes ;)

# models.js
#= require_tree models/mixins
#= require_tree models
#= require_tree models/extensions

And so on ...

Vendor libs included

These vendor libs can be required directly in your application.js.coffee.

Alternatively create a vendor.js.coffee which you require from application.js.coffee.

Note: Some vendor libs will need to be required after require app/app_loader, if they hook into the Application classes you have defined (f.ex rails.validations.ember lib).

Test setup

For easy test setup of your project, try using the ember-konacha-rails gem ;)

TODO: In the future Test setup is likely to be integrated directly in this gem!

Also look at ember-tools for more tooling!!

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request