diff --git a/.gitignore b/.gitignore index f7d4a3c..72189e9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,36 @@ -node_modules +# messageBoard config config.json + +# Logs +logs +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +node_modules + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history diff --git a/README.md b/README.md new file mode 100644 index 0000000..35be6b1 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# nodeMessageBoard +A SMS Messageboard using node.js + +## Install +node message board works using a sim900 module connected using a usb serial converter. +Make sure you have the needed drivers installed. + +run `npm install` to install the dependencys (socket.io, lowdb, serialport) + +rename sample.config.json to config.json and add your serialport and pincode into it + +then run `node app.js` to run the server. + +http://lbsfilm.at/