Permalink
Browse files

Readme additions

  • Loading branch information...
1 parent 7f63082 commit bd4cd5b46e2f731eeabb684346e0c628232a056b @robrighter committed Aug 18, 2010
Showing with 18 additions and 4 deletions.
  1. +7 −0 README.md
  2. +11 −4 project/app.js
View
@@ -2,6 +2,12 @@ Node Boilerplate
=================
node-boilerplate takes html-boilerplate, express, connect and Socket.IO and organizes them into a ready to use website project. Its a fast way to get working on your Node website without having to worry about the setup. It takes care of all the boring parts, like setting up your views, 404 page, 500 page, getting the modules organized, etc...
+Node Boilerplate has 3 goals:
+
+1. To end the repetition involved with starting a new Node website project
+1. To never install anything outside of the project directory (For easier production deployment)
+2. To make it easy to install additional modules within the project directory
+
To start a project:
@@ -11,6 +17,7 @@ To start a project:
This will copy down all of the boilerplate files organize them appropriately and init a fresh new git repository within which you can build your next big thing.
+
To run the boilerplate template app:
node ./project/app.js
View
@@ -18,14 +18,21 @@ server.configure(function(){
//setup the errors
server.error(function(err, req, res, next){
if (err instanceof NotFound) {
- res.render('404.ejs');
+ res.render('404.ejs', { locals: {
+ header: '#Header#'
+ ,footer: '#Footer#'
+ ,title : '404 - Not Found'
+ ,description: ''
+ ,author: ''
+ ,analyticssiteid: 'XXXXXXX'
+ } });
} else {
res.render('500.ejs', { locals: {
header: '#Header#'
,footer: '#Footer#'
- ,title : 'Page Title'
- ,description: 'Page Description'
- ,author: 'Your Name'
+ ,title : 'The Server Encountered an Error'
+ ,description: ''
+ ,author: ''
,analyticssiteid: 'XXXXXXX'
,error: err
} });

0 comments on commit bd4cd5b

Please sign in to comment.