Browse files

Added readme file and rm's to init script

  • Loading branch information...
1 parent bcace7b commit 915253c471b20ed0cd994f6743f8d5e4370ad81e @robrighter committed Aug 17, 2010
Showing with 29 additions and 1 deletion.
  1. +23 −0 README.md
  2. +6 −1 bin/initproject.sh
View
23 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').
+
View
7 bin/initproject.sh
@@ -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.