Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added readme file and rm's to init script
- Loading branch information
1 parent
bcace7b
commit 915253c
Showing
2 changed files
with
29 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,23 @@ | |||
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. | |||
|
|||
|
|||
To start a project: | |||
|
|||
git clone git://github.com/robrighter/node-boilerplate.git mynewproject | |||
cd mynewproject | |||
sh ./bin/initproject.sh | |||
|
|||
|
|||
To run the boilerplate template app: | |||
|
|||
node ./project/app.js | |||
(click on the send message link to see socket.io in action) | |||
|
|||
|
|||
|
|||
To add additional modules: | |||
|
|||
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'). | |||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters