Node ©2013 - 2014 Nobuyori Takahashi < voltrue2@yahoo.com >

##Installation

###Installation via NPM

To install GraceNode you can either add it to your package.json like so,

{
    "dependencies": {
        "GraceNode": "git+https://github.com/voltrue2/GraceNode.git#master"
    }
}

or NPM install directly via npm install git+https://github.com/voltrue2/GraceNode.git#master.

###Creating configuration files

In your root directory create a directory that is called 'configs'. Although you can name it whatever you want, for this instruction we have named our directory configs.

$ mkdir configs/
$ touch configs/conf.json

Refer to example-config.json for an example configuration file.

##Bootstrapping GraceNode

GraceNode needs to be set up for it to run correctly. In your application add:

var gracenode = require('GraceNode');
//Set the configuration path.
gracenode.setConfigPath('configs/');
//Add configuration files that need to be loaded.
gracenode.setConfigFiles(['conf.json']);

// decide what module(s) of GraceNode to use in your application.
gracenode.use('server');
gracenode.use('view');
gracenode.use('mysql');

// now start the set up process
gracenode.setup(function (error) {
    if (error) {
        throw new Error('GraceNode failed to set up: ' + error);
    }
    // GraceNode is ready to go

});

#Gracenode ##Methods

###.setConfigPath(configDirectoryPath [string]) Tells GraceNode where to find the configuraitons files.

gracenode.setConfigPath('configs/');

###.setConfigFiles(configFileList [array]) Give GraceNode the list of configuration files to be used. The files must be in the directory given to setConfigFiles.

gracenode.setConfigFiles(['conf.json']);

###.use(moduleName [string], params [object*]) Tells GraceNode what modules to load when calling the setup functions.

gracenode.use('mysql');
gracenode.use('myModule');

###.setup(callback [function]) Start the setting up of GraceNode modules.

gracenode.setup(function(error) {
    if (error) return console.error('Could not load gracenode:', error);
});

###.exit(errorMessage [string*]) Exits GraceNode and attempts to gracefully shutdown the process. You can give it an error message in case you want to stop the process due to an error.

gracenode.exit('financialCrisis');

##Events Gracenode has the capabilities to emit events, you can catch these events using:

gracenode.on('event.name', yourEventHandler);

###setup.config Emitted when the config module has been set up. ###setup.log Emitted when the log module has been setup. ###setup.complete Emitted when the setup has been completed. ###setup.moduleName Emitted when a specific module has been setup. ###uncaughtException Emitted when GraceNode caught an uncaught exception. ###exit Emitted when GraceNode exits. ###shutdown Emitted when GraceNode detects SIGINT. This is before exit is emitted.

#Default Modules By default GraceNode automatically loads the following modules. Click on the link to read more about them. ###Config Handles everything config related. ###Log Takes care of logging. ###Profiler Used to profile your application so you can easily determine bottlenecks in your application. ###Lib Contains a plethora of commonly used functions like random integer generation. #Additional Modules ###StaticData Allows for easy loading of static data such as JSON and CSV files. ###Request Handles requests to the server. ###Server Handles requests to the server. ###UDP A module that makes it easier to handle UDP traffic from and to your server. ###View Manages, loads and creates views you can server to clients. ###Session Handles sessions and automatically expires them if they are not accessed within a preset amount of time. ###Encrypt Contains functions that make it easier to deal with crypography and password hashing. ###MySQL A wrapper to handle MySQL connections without the hassle of maintaining your connection pool. ###Datacache Allows you to cache queries to MySQL and other requests. ###Asset Asset management. ###[Memcache] (modules/memcache) Memcache management.

[Iap] (modules/iap)

Apple and GooglePlay in-app-purchase validation.

[Wallet] (modules/wallet)

Coin management.

Useing GraceNode With Apache

apache configuration example

# proxy to nodejs process
<VirtualHost *:80>
    ServerAdmin yourname@yourdomain.com
    DocumentRoot /var/www/yourdomain.com/htdocs
    ServerName yourdomain.com

    ProxyRequests off

    <Proxy *>
        Order deny,allow
        Allow from all
    </Proxy>

    ProxyPreserveHost on
    ProxyPass /asset ! # do not proxy this path
    ProxyPass / http://yourdomain.com:8000/ # proxy everything else to GraceNode
    ProxyPassReverse / yourdomain.com:8000/

</VirtualHost>