README.md

Express application seed

Introduction

The purporse of this project is to create a real life web application plinth to learn good coding practices and functional strategies.

Good coding practices:

• No duplication (DRY)
• Orthogonality (Eliminate effects between unrelated things)
• Decoupling
• Testing

Functional Strategies:

• Signing up
  • http://davidcel.is/blog/2012/09/06/stop-validating-email-addresses-with-regex/
• Login
• Locale
• Contact

Main librairies used

• Coffeescript
• ExpressJs
• TwitterBootstrap
• MongooseJs
• Jade
• PassportJs
• Nodemailer
• Formidable

Setup

Installation

$ npm install -g coffee-script
$ npm install -g mocha
$ npm install
$ git submodule sync
$ git submodule update --init --recursive
$ bower install

Prerequisite

Install Redis

compile client coffeescripts on save:

$ coffee -wcb -o public/javascripts/ public/coffeescripts/*.coffee

Running

$ coffee app.coffee

Tests

launch tests:

$ make REPORTER=dot test

launch unit tests:

$ make REPORTER=dot test-unit

Unit tests table of content

launch functional tests:

$ make REPORTER=dot test-functional

Functional tests table of content