Permalink
Browse files

Updated readme

  • Loading branch information...
1 parent 79f4b5b commit 6164480ad25f86818645b418e2be747b3ed0119c @mrako committed Jun 22, 2014
Showing with 24 additions and 1 deletion.
  1. +2 −1 Gruntfile.js
  2. +22 −0 README.md
View
@@ -27,7 +27,8 @@ module.exports = function(grunt) {
}
});
- grunt.registerTask('default', ['express:dev', 'open', 'watch']);
+ grunt.registerTask('server', ['express:dev', 'open', 'watch']);
+ grunt.registerTask('default', ['server']);
grunt.loadNpmTasks('grunt-express-server');
grunt.loadNpmTasks('grunt-contrib-watch');
View
@@ -0,0 +1,22 @@
+# Todo App
+
+This is a simple app built using MongoDB, NodeJS and AngularJS.
+
+* NodeJS provives an API to the DB.
+* AngularJS provides the frontend using the API.
+
+## Prerequisites
+
+* [MongoDB](http://www.mongodb.org/)
+* [NPM](https://github.com/npm/npm)
+* [NodeJS](http://nodejs.org/)
+* [Grunt](http://gruntjs.com/)
+* [Bower](http://bower.io/)
+
+## Installation
+
+1. Clone the repository: `git clone git@github.com:mrako/todo-nodejs-angularjs`
+2. Install dependencies: `npm install`
+2. Install components: `npm install`
+3. Start db: `mongod --dbpath db/data`
+3. Start server: `grunt server`

0 comments on commit 6164480

Please sign in to comment.