Marionette Boilerplate

Introduction

This project is first to train with tools like GruntJS, Yeoman, Backbone.js, Marionette.js...

Requirements

• nodejs
• GruntJS
• bower
• compass

Optional

• Mongodb: it's mandatory when the 'stub' mode is disabled
• Install on Ubuntu
• Install on OS X
• Yeoman: required by generator-marionette
• generator-marionette: Allows the use of yo command to generate routers, models, views ...

Installation

• $ git clone [email protected]/kiki-le-singe/read-list.git
• $ cd read-list
• $ npm install
• $ bower install

Grunt tasks

• $ grunt serve: Requirements: mongodb, mongoose

Then serve the app on localhost:9000 and opens your default browser

• $ grunt serve --stub

Makes the same thing that the above command, except that the 'stub' option allows to enabled or not the retrieving of fake datas.

• $ grunt test

Runs tests located in /tests/js/spec.

You can access tests in your browser, simply create a vhost.

Included JavaScript libraries

• Backbone.js
• Marionette.js
• Backbone.babysitter
• Backbone.wreqr
• Require.js
• jQuery 2
• Lo-Dash
• Handlebars
• Modernizr

API

By default the root access for the API is http://localhost:9000/api. Available example: http://localhost:9000/api/libraries

Tests

The library used for tests are :

• mocha
• sinon
• chai

App configuration

The configuration of the application is located in /app/config

Handlebars helpers

Handlebars helpers is located in /app/scripts/helpers

Sources

• marionette-boilerplate: read-list is based on it

Tips and tricks

• mongo-express: If you use MongoDB, look at this node modules. It's an convenient admin interface for MongoDB.