SNOWF

a simple nodeJS web framework

GET START

1. npm install snowframework --save
2. create appsetting.json in root dir, refer to following example
3. create following dir: controller, views, wwwroot
4. create new controller in controller dir and create new index.html in views dir
5. cteate index.js in root dir, refer to following example
6. excute > node index.js

index.js Example

//require snowframework
const app = require('snowframework');
const appsetting = require('./appsetting');

//init with appsetting.json
app.init(appsetting.snowf);
//add controller
app.addController('home', require('./controllers/homeController'));
app.addController('docs', require('./controllers/docsController'));
//start app
app.start();

appsetting.json Example

this file need snowf node

{
    "snowf": {
        "environment": "developments", 
        "port": "8089",
        "router": {
            "default": "home", 
            "error": "/shared/error.html", 
            "views": "./example/views", 
            "layout":"./example/views/shared",
            "root": "./example/wwwroot" 
        }
    }
}

environment : set the environment, if 'development', you will recive the debug info, else it will show the custom error page

port : the server port

default : default page

error : custom error page

views : views dir

layout: layout page dir

root : static resouce dir