README.markdown 4.67 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[![](https://framagit.org/assets/favicon-075eba76312e8421991a0c1f89a89ee81678bcde72319dd3e8047e2a47cd3a42.ico)](https://framagit.org)

![English:](https://upload.wikimedia.org/wikipedia/commons/thumb/a/ae/Flag_of_the_United_Kingdom.svg/20px-Flag_of_the_United_Kingdom.svg.png) **Framasoft uses GitLab** for the development of its free softwares. Our Github repositories are only mirrors.
If you want to work with us, **fork us on [framagit.org](https://framagit.org)**. (no registration needed, you can sign in with your Github account)

![Français :](https://upload.wikimedia.org/wikipedia/commons/thumb/c/c3/Flag_of_France.svg/20px-Flag_of_France.svg.png) **Framasoft utilise GitLab** pour le développement de ses logiciels libres. Nos dépôts Github ne sont que des miroirs.
Si vous souhaitez travailler avec nous, **forkez-nous sur [framagit.org](https://framagit.org)**. (l'inscription n'est pas nécessaire, vous pouvez vous connecter avec votre compte Github)
* * *

Framemo est la version traduite et personnalisée du logiciel Scrumblr que l'association Framasoft propose sur le site :
https://framemo.org
La personnalisation s'appuie sur la librairie Bootstrap dont les fichiers se trouvent dans la [Framanav](https://framagit.org/framasoft/framanav).

* * *

ali asaria's avatar
ali asaria committed
16
17
18
19
20
scrumblr
========

what is it
----------
ali asaria's avatar
ali asaria committed
21
[scrumblr](http://scrumblr.ca) is a web-based simulation of a physical agile kanban 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
22

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

ali asaria's avatar
ali asaria committed
25
26
you can play with a demo here:

ali asaria's avatar
ali asaria committed
27
- [scrumblr.ca/demo](http://scrumblr.ca/demo)
ali asaria's avatar
ali asaria committed
28
29
30

And view a video here:

ali asaria's avatar
ali asaria committed
31
- [Video Demo](http://www.youtube.com/watch?v=gAKxyOh1zPk)
ali asaria's avatar
ali asaria committed
32
33
34
35

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

36
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
37

ali asaria's avatar
ali asaria committed
38
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
39

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

ali asaria's avatar
ali asaria committed
42
43
44
browser support
---------------

45
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
46
47
48

design philosophy
-----------------
ali asaria's avatar
ali asaria committed
49
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
50

ali asaria's avatar
ali asaria committed
51
![Wellca Board](http://scrumblr.ca/images/DSC_7093.jpg)
ali asaria's avatar
ali asaria committed
52
53
54
55
56


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

57
58
- [install redis](http://redis.io/download) (last tested on v2.8.4)
- [install node.js](http://nodejs.org/) (last tested on v0.10.30)
59
- install npm (if you're running node.js [v0.6.3](https://github.com/joyent/node/commit/b159c6) or newer it's already installed!)
60
- cd to the scrumblr directory; you should see server.js and config.js and other files.
61
- run `npm install`
Ali Asaria's avatar
Ali Asaria committed
62
- run redis `redis-server`
Per Guth's avatar
Per Guth committed
63
- run scrumblr `node server.js --port 80` where "80" is the port you have opened in your firewall and want scrumblr to run on. 
ali asaria's avatar
ali asaria committed
64
- open a browser to `http://<server>:<port>` where `<server>` is your server's url or IP address, and `<port>` is the port you chose in the previous step.
65

ali asaria's avatar
ali asaria committed
66
license
ali asaria's avatar
ali asaria committed
67
68
-------

ali asaria's avatar
ali asaria committed
69
70
71
72
73
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.

74
scrumblr is distributed in the hope that it will be useful,
ali asaria's avatar
ali asaria committed
75
76
77
78
79
80
81
82
83
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
84
85
86
87

author
------

88
ali asaria