chrisabrams / node-express-socketio

A simple boilerplate for starting a new node.js project.

Node, Express & Socket.io

A simple boilerplate node.js, express.js & socket.io

I created this repo as I kept making new node.js projects and was copying resources from different places. Eventually things got to spread out and I couldn't figure out which project had the most up to date setup. I've tried to break things out into their respective config/lib files for easier organization.

You'll need a few things to get started:

• Node.js
  This setup uses node.js version 0.6.15

If node.js is installed run the following:

npm install

Starting the server

npm start

The server can be found at 0.0.0.0:8081

##Features

• View engine is using Jade
• Theme organizer
• Client/server communication baked into layout.jade using web sockets and the Socket.io library.
• Repo contains multiple branches with different options/setups

Theme Organization

The settings file has a basic theme organization. To change the theme just modify:

theme: 'themename'

To add or modify a theme:

themes: {
	themename: {
		errors: {
			notfound: 'path/to/404'
		},
		index: '/path/to/index',
		layout: '/path/to/layout'
	}
}

The idea is to keep it simple when using more than one set of views.

###Nodejitsu Deployment The package.json file is setup for deployment with Nodejitsu.

Branches

- [Master](https://github.com/chrisabrams/node-express-socketio) General boilerplate setup. - [MVC](https://github.com/chrisabrams/node-express-socketio/tree/MVC) Basic routing to controller from URL segments