asaarinen / nox-app-template

Nox.js app template using Bootstrap 3

Nox.js Application Template

This project is an easy and simple template for getting a Nox.js app up and running in Node.js. It includes login and main pages to start building upon.

Directory Structure

html - includes all static template files app - includes all application html files lib - includes all application client and server JavaScript modules

Getting Started

To get started, install via npm:

npm install nox-app-template

Now the application is ready to be run like this:

node nox-start.js [<port>]

After this, you can go to localhost:<port>/login.html and login using credentials username and usernamepass.

To play around and add modules and pages to your project, please modify nox-start.js where the pages are added to the app:

noxapp.page('/login.html', [ './lib/auth.js' ], [ './lib/login.js' ]);
noxapp.page('/index.html', [ './lib/auth.js', './lib/app.js' ], [ './lib/index.js' ]);

You can also create a new app in your own project similarly as it is done in nox-start.js:

var noxapp = require('nox-app-template')('appname', 8080);

// ... add pages etc.

// remember to serve your application-specific html files
noxapp.expressServer.use(express.static('html')); 

3rd Party Software

This project uses the following 3rd party software, included in the html/ directory:

• jQuery v1.10.2, Copyright 2005, 2013 jQuery Foundation, Inc. and other contributors, see license here
• Bootstrap v3.0, Copyright 2013 Twitter, Inc under the Apache 2.0 license, see license here
• respond.min.js, Copyright 2011: Scott Jehl, scottjehl.com, MIT licensed
• html5shiv, see here, MIT licensed

License

(The MIT License)

Copyright (c) 2013 Antti Saarinen <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.