Home

This doc is dedicated to detail more the layout and dev tools of the project.

Architecture

.
├── assets                # Assets: style, js, images...
├── lib                   # core components
|   ├── config            # App config
|   └── app.js            # main file of the application
├── public                # web root
├── test                  # Unit tests
└── views                 # JADE templates            

Database model

For the given user object:

user = {
    name: "John",               # Mandatory
    email: "john@example.com",  # Mandatory
    password: "password",       # Mandatory
    isAdmin: false,             # Optional, if not specified is set to false
    language: 'fr',
    ...
    property: value
}

It is stored as the following:

user:John: "password"
user:john@example.com: "John"       # Gives the user name
user:John:email: "john@example.com"
user:John:isAdmin: false
user:John:language: "fr"
...
user:John:property: value

Development

Update the project:

npm update

For development purpose, install the development dependencies:

npm update --save-dev

Grunt tasks

Publish assets

// CSS
grunt css       // dev
grunt css-prod  // prod

// JS
grunt js        // dev
grunt js-prod   // prod

// Everything
grunt publish   // prod
grunt build     // dev

Watch task

grunt watch

Run tests

npm test