aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
blob: fc487a7f778a29784f114f73bac213466a680491 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
#+STARTUP: showall

I know next to nothing about scrum. I know only that I want to stay
away from it as much as I can. So here I am writing a project to help
us (eventually) scrum.

* Requirements

  It ...

  - ... is written in Common Lisp. Specifically it is written for ~sbcl~.
  - ... uses Mozilla Persona for authentication and ~drakma~ to
    communicate with Mozilla Persona.
  - ... uses Gravatar for avatars and ~md5~ to get the Gravatar avatars
  - ... uses the ~ningle~ web framework.
  - ... uses PostgreSQL as a database and ~postmodern~ to talk to
    the database.
  - ... uses ~cl-json~ to generate JSON.
  - ... uses ~closure-template~ for the few templates it has.
  - ... uses bootstrap for layout.
  - ... uses jQuery for some of the JavaScript functionality.
  - ... uses Font Awesome for icons.
  - ... and uses React for the UI.

  In other words you need to have the following software installed:

  - [[http://sbcl.org][SBCL]]
  - [[http://postgresql.org][PostgreSQL]]

  And the following Common Lisp packages:

  - ~drakma~
  - ~md5~
  - ~ningle~
  - ~postmodern~
  - ~cl-json~
  - ~closure-template~

  ... which should all be available through [[http://quicklisp.org][Quicklisp]]. And the
  following JavaScript and/or CSS frameworks and libraries are pulled
  from CDN's by default, but may be customized to load from anywhere
  you wish:

  - [[http://twitter.github.io/bootstrap][Bootstrap]]
  - [[http://jquery.com][jQuery]]
  - [[http://fontawesome.io][Font Awesome]]
  - [[http://facebook.github.io/react][React]]

* License

  scrumli is free software: you can redistribute it and/or modify it
  under the terms of the GNU Affero General Public License as
  published by the Free Software Foundation, either version 3 of the
  License, or (at your option) any later version.

  scrumli is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public
  License along with scrumli.  If not, see
  [[http://www.gnu.org/licenses/]].

  See [[http://code.ryuslash.org/cgit.cgi/scrumli/tree/COPYING][COPYING]] for more information.