README.markdown 3.32 KB
Newer Older
ali asaria's avatar
ali asaria committed
1
2
3
4
5
scrumblr
========

what is it
----------
6
[scrumblr](http://scrumblr.ca) is a web-based simulation of a physical agile sprint board that supports real-time collaboration. it is built using node.js, websockets (using socket.io), CSS3, and jquery. i hope you like it.
ali asaria's avatar
ali asaria committed
7

ali asaria's avatar
ali asaria committed
8
![Wellca Board](http://scrumblr.ca/images/screenshot.png)
ali asaria's avatar
ali asaria committed
9

ali asaria's avatar
ali asaria committed
10
11
you can play with a demo here:

ali asaria's avatar
ali asaria committed
12
- [scrumblr.ca/demo](http://scrumblr.ca/demo)
ali asaria's avatar
ali asaria committed
13
14
15

And view a video here:

ali asaria's avatar
ali asaria committed
16
- [Video Demo](http://www.youtube.com/watch?v=gAKxyOh1zPk)
ali asaria's avatar
ali asaria committed
17
18
19
20

use scrumblr
------------

21
if you'd like to use scrumblr go to [scrumblr.ca](http://scrumblr.ca). new boards are made simply by modifying the url to something unique. e.g. your team could use a shared board at: *http://scrumblr.ca/thisisoursecretboard23423242*
ali asaria's avatar
ali asaria committed
22

ali asaria's avatar
ali asaria committed
23
alternatively, you can follow the instructions below to setup scrumblr yourself. it is very simple -- it just uses redis and node.js.
ali asaria's avatar
ali asaria committed
24

ali asaria's avatar
ali asaria committed
25
26
if you are a developer, please fork and submit changes/fixes.

ali asaria's avatar
ali asaria committed
27
28
29
browser support
---------------

30
scrumblr works on up to date chrome and firefox browsers. enable websockets for optimal performance. tested mainly on chrome for osx. this was not designed for browser support. use chrome for this app.
ali asaria's avatar
ali asaria committed
31
32
33

design philosophy
-----------------
ali asaria's avatar
ali asaria committed
34
my goal was to avoid buttons and ui (almost everything is edit in place or draggable). everything should be discoverable (no "help"). the look is meant to be as close as possible to [Well.ca's](http://well.ca) real sprint board. see picture below. many of the decisions were to make the app look and feel as much as possible like well.ca's real sprint board -- you may find this annoying but we find it kinda funny.
ali asaria's avatar
ali asaria committed
35

ali asaria's avatar
ali asaria committed
36
![Wellca Board](http://scrumblr.ca/images/DSC_7093.jpg)
ali asaria's avatar
ali asaria committed
37
38
39
40
41


how to install and run on your own computer (linux/osx)
-------------------------------------------------------

ali asaria's avatar
ali asaria committed
42
43
- install redis v2.2.2
- install node.js >= 0.4.1
ali asaria's avatar
ali asaria committed
44
45
46
47
48
49
50
51
- install npm
- install these npm packages:
	- async
	- express
	- jade
	- redis-client
	- redis
	- sanitizer
ali asaria's avatar
ali asaria committed
52
	- socket.io@0.6.16 (you need to install a 0.6.x version of socket.io until the code is updated to work with the 0.7.x version)
ali asaria's avatar
ali asaria committed
53
54
	- simplesets
	- connect-redis
Rod Knowlton's avatar
Rod Knowlton committed
55
  - connect
ali asaria's avatar
ali asaria committed
56
	- (and perhaps more which you will notice when you try to start it)
ali asaria's avatar
ali asaria committed
57
58
59
- now start redis ($ redis-server)
- now start ($ node server.js 80) where "80" is the port you want it to run on. 

ali asaria's avatar
ali asaria committed
60
license
ali asaria's avatar
ali asaria committed
61
62
-------

ali asaria's avatar
ali asaria committed
63
64
65
66
67
scrumblr is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

68
scrumblr is distributed in the hope that it will be useful,
ali asaria's avatar
ali asaria committed
69
70
71
72
73
74
75
76
77
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

See <http://www.gnu.org/licenses/>.

the *images* used in scrumblr, however are licensed under cc non commercial noderivs:

<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-nc-nd/3.0/80x15.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/">Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License</a>.
ali asaria's avatar
ali asaria committed
78
79
80
81

author
------

82
ali asaria - [well.ca](http://well.ca) - ali [at] well.ca