NOKIA DATA GATHERING
================================

* Info: See <http://> for introductory docs.
* Author: Ian Lawrence <root@ianlawrence.info>
* Date: $Date: 2011-08-12 12:50:48 -0400 (Fre, 12. Aug 2011) $
* Revision: $Revision: 2 $
* Description: This is the main documentation


GETTING STARTED
================================

    mysql> CREATE DATABASE ndg2;
    git clone git@github.com:nokiadatagathering/ndg-ng.git
    cd assets/build/
    ant build
    (install necessary tools to optimize assets using apt until ant stops complaining)
    cd ../..
    play run
    http://localhost:9000/


DEVELOPER PRACTICES
================================


We are using Git as the Source Control Manager (SCM)

Our Documentation style is Markdown


APPLICATION LAYOUT
================================


1. app/ contains the application's core, split between models, controllers and views directories. It can contain other Java packages as well. This is the directory where .java source files live.

2. conf/ contains all the configuration files for the application, especially the main application.conf file, the routes definition files and the messages files used for internationalization.

3. lib/ contains all optional Java libraries packaged as standard .jar files.

4. public/ optimized assets which represent the front end of the site. It includes JavaScript files, stylesheets and images directories.

5. assets/ source files (html, css, javascript). The ant build file in assets/build optimizes these files and then places them in the assets/public directory. The folder does not need to be deployed when going live.

6. test/ contains all the application tests. Tests are either written either as Java JUnit tests or as Selenium tests