Skip to content

Commit

Permalink
Added readme file and rm's to init script
Browse files Browse the repository at this point in the history
  • Loading branch information
robrighter committed Aug 17, 2010
1 parent bcace7b commit 915253c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
23 changes: 23 additions & 0 deletions README.md
@@ -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').

7 changes: 6 additions & 1 deletion bin/initproject.sh
Expand Up @@ -15,7 +15,12 @@ cp ./lib/html5-boilerplate/css/style.css ./project/static/css/style.css
cp ./lib/html5-boilerplate/robots.txt ./project/static/robots.txt

echo "Removing the stuff you dont want..."

rm -rf .git
rm -rf bin
rm README.md

echo "Initing the new git project..."
git init
git add .
git commit -m"Initial Commit"

0 comments on commit 915253c

Please sign in to comment.