DIRTy App!

Synopsis

This is a Node.js application built using express web application framework, MongoDB for the storage and Socket.IO. This application is mainly composed of three modules. The user authentication module which uses passportjs, the drawing module which is built using HTML5 canvas API and last but not the least is the chat module. As the project name says, this is a Data Intensive Real Time application and this is what Node.js is being intended for. :)

Motivation

This application can have multiple use cases (e.g. online classroom, discuss project document) but generally it is a real-time collaboration tool. This can be use to discuss something via chat or if there are things you cannot express via chat, you can draw it on the board.

Installation

NOTE: You need to have node.js, mongodb and installed and running.

  $ git clone https://github.com/rtorino/shiny-octo-ironman.git
  $ npm install
  $ npm start

Then visit http://localhost:3000/

Dependencies

1. express - Sinatra inspired web development framework for node.js.
2. jade - Node template engine.
3. mongodb - Open-source document database, and the leading NoSQL database.
4. passport - Simple, unobtrusive authentication for Node.js.
5. passport-local - Username and password authentication strategy for Passport and Node.js.
6. mongoose - elegant mongodb object modeling for node.js
7. connect-flash - Flash message middleware for Connect and Express.
8. pwd - Hash and compare passwords with pbkdf2
9. view-helpers - Express view helper methods
10. connect-mongo - MongoDB session store for Connect.
11. socket.io - Realtime application framework for Node.JS, with HTML5 WebSockets and cross-browser fallbacks support.
12. passport.socketio - Access passport.js authenticated user information from socket.io connection
13. underscore - JavaScript's utility _ belt

Directory structure

-app/
  |__controllers/
  |__models/
  |__views/
-config/
  |__routes.js
  |__config.js
  |__passport.js (auth config)
  |__express.js (express.js configs)
  |__middlewares/ (custom middlewares)
-lib/
  |__utils.js
-public/

To Do

1. Add HTML5 local storage API feature
2. Ability to add shape objects
3. Add sticky notes feature on the board
4. Implement Undo and Redo functionality
5. ..and a lot more... :)

License

(The MIT License)

Copyright (c) 2013 Raymond Torino < [email protected] >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.