Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 36 lines (19 sloc) 1.629 kb
915253c @robrighter Added readme file and rm's to init script
authored
1 Node Boilerplate
2 =================
9c03ce1 @robrighter Added 404 and 500 pages
authored
3 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...
915253c @robrighter Added readme file and rm's to init script
authored
4
5414035 @robrighter Readme updates and server configuration ordering change
authored
5 Node Boilerplate has 4 goals:
bd4cd5b @robrighter Readme additions
authored
6
7 1. To end the repetition involved with starting a new Node website project
5414035 @robrighter Readme updates and server configuration ordering change
authored
8 2. To never install anything outside of the project directory (For easier production deployment)
9 3. To make it easy to install additional modules within the project directory
10 4. To enable easy upgrade or freezing of project dependencies
bd4cd5b @robrighter Readme additions
authored
11
915253c @robrighter Added readme file and rm's to init script
authored
12
13 To start a project:
14
15 git clone git://github.com/robrighter/node-boilerplate.git mynewproject
16 cd mynewproject
33ec55d @robrighter Updated readme to reflect the new structure
authored
17 ./bin/initproject.sh
0d58b9e @robrighter Readme update
authored
18 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.
915253c @robrighter Added readme file and rm's to init script
authored
19
20
bd4cd5b @robrighter Readme additions
authored
21
915253c @robrighter Added readme file and rm's to init script
authored
22 To run the boilerplate template app:
23
33ec55d @robrighter Updated readme to reflect the new structure
authored
24 node server.js
0d58b9e @robrighter Readme update
authored
25
26 Go to http://0.0.0.0:8081 and click on the send message link to see socket.io in action.
915253c @robrighter Added readme file and rm's to init script
authored
27
28
29
30 To add additional modules:
31
32 You can git clone any other modules into the lib folder. Any modules cloned into the git folder can be required as global modules ie.. require('somemodule').
33
1909f2b @robrighter Updated the readme file
authored
34 **If you have a different set of default modules that you like to use, the structure is setup such that you can fork the project and replace the modules in the lib directory and the initproject.sh script will initialize projects with your new set of modules.**
35
Something went wrong with that request. Please try again.