Skip to content
Newer
Older
100644 51 lines (32 sloc) 2.27 KB
9f67c1c @robrighter removed old ejs files and updated the readme and config for new node …
authored Dec 30, 2011
1 Node Boilerplate Version 2
2 ==========================
3 *Requires Node v0.6.6 (or newer)*
13a97e5 @robrighter Setup package.json to use npm automated install. Also added .gitignor…
authored Dec 30, 2011
4 node-boilerplate takes html-boilerplate, express, connect, jade 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 Aug 17, 2010
5
5414035 @robrighter Readme updates and server configuration ordering change
authored Aug 17, 2010
6 Node Boilerplate has 4 goals:
bd4cd5b @robrighter Readme additions
authored Aug 17, 2010
7
8 1. To end the repetition involved with starting a new Node website project
5414035 @robrighter Readme updates and server configuration ordering change
authored Aug 18, 2010
9 2. To never install anything outside of the project directory (For easier production deployment)
10 3. To make it easy to install additional modules within the project directory
11 4. To enable easy upgrade or freezing of project dependencies
9f67c1c @robrighter removed old ejs files and updated the readme and config for new node …
authored Dec 30, 2011
12 (These goals are much easier to meet now that node includes the node_modules convention)
915253c @robrighter Added readme file and rm's to init script
authored Aug 17, 2010
13
14 To start a project:
15
16 git clone git://github.com/robrighter/node-boilerplate.git mynewproject
17 cd mynewproject
fe2808f @robrighter dir structure simplification
authored Dec 30, 2011
18 ./initproject.sh
0d58b9e @robrighter Readme update
authored Aug 17, 2010
19 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 Aug 17, 2010
20
21
22 To run the boilerplate template app:
23
33ec55d @robrighter Updated readme to reflect the new structure
authored Aug 30, 2010
24 node server.js
0d58b9e @robrighter Readme update
authored Aug 17, 2010
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 Aug 17, 2010
27
28
13a97e5 @robrighter Setup package.json to use npm automated install. Also added .gitignor…
authored Dec 30, 2011
29 Additional Features:
30
31 1. Creates a package.json file consistent with associated best practices (http://blog.nodejitsu.com/package-dependencies-done-right)
32 2. Adds .gitignore for the node_modules directory
33 3. Includes 404 page and associated route
34 4. Includes 500 page
915253c @robrighter Added readme file and rm's to init script
authored Aug 17, 2010
35
36 To add additional modules:
37
13a97e5 @robrighter Setup package.json to use npm automated install. Also added .gitignor…
authored Dec 30, 2011
38 Update the package.json file to include new module dependancies and run 'npm install'.
915253c @robrighter Added readme file and rm's to init script
authored Aug 17, 2010
39
13a97e5 @robrighter Setup package.json to use npm automated install. Also added .gitignor…
authored Dec 30, 2011
40 **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 module dependancies outlined in the ./templates/apps/package.json file to best fit your needs and the initproject.sh script will initialize projects with your new set of modules.**
1ca61a8 @robrighter
authored Jan 10, 2011
41
42 Deployment
43 ===============
27c0640 @robrighter Updated documentation to include deployment info
authored Jan 10, 2011
44
43f58b4 @robrighter Documentation typo fix
authored Jan 10, 2011
45 node-boilerplate is setup to be easily deployed on a Joyent Node SmartMachine. This means that:
27c0640 @robrighter Updated documentation to include deployment info
authored Jan 10, 2011
46
13a97e5 @robrighter Setup package.json to use npm automated install. Also added .gitignor…
authored Dec 30, 2011
47 1. The version of Node is defined in config.json and in package.json
1ca61a8 @robrighter
authored Jan 10, 2011
48 2. The main script to run is server.js
49 3. The web server port is pulled from process.env.PORT
27c0640 @robrighter Updated documentation to include deployment info
authored Jan 10, 2011
50
Something went wrong with that request. Please try again.