forked from kanban/kanban-app
-
Notifications
You must be signed in to change notification settings - Fork 0
/
kanban-app-set-up.html
97 lines (96 loc) · 4.57 KB
/
kanban-app-set-up.html
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE></TITLE>
</HEAD>
<BODY LANG="en-NZ" DIR="LTR">
<H1>How to set up the Kanban App</H1>
<H2>Prerequisites</H2>
<P>The Kanban App is a Java web application archive
("war" file). To run it you need to have a box running
a Java web application server such as Tomcat or Jetty. Ideally
you should have experience with deploying Java web applications
to your application server and you will need to know the host
name and port number of your application server.</P>
<H2>Deploy kanban.war</H2>
<P>Deploy the kanban.war file to the web application server.
Application servers typically allow you to do this by copying
the war file to the application server's webapps directory.
There may also be an "manager" website you can connect
to that will allow you to deploy the war file by uploading it
from a web page.</P>
<H2>Verify deployment</H2>
<P>Verify the installation. Navigate to
http://<host>:<port>/kanban. If you are connecting
from the box that is running the web application server you can
use "localhost" for <host>. The port is probably
either 80 (the standard port) or 8080. If you connect to this
URL you should see a page like this:
<DIV STYLE="border: 1px solid; padding: 0px 15px 0px 15px">
<h1>Kanban App</h1>
<table>
<tr>
<th style="text-align: left">Version</th>
<td>24</td>
</tr>
<tr>
<th style="text-align: left">Kanban Home</th>
<td>/home/username/.kanban</td>
</tr>
</table>
<p>
<a href="">Click here</a> to create the Kanban Home
directory with a sample project.
</p>
</DIV>
<H2>Configure a project</H2>
<P>Click where it says “click here” and the Kanban App will
create you a sample project to experiment with. You can create
other projects by clicking the “Create Project” button from
within the sample project.</P>
<H2>Verify configuration</H2>
<P>You should now see one project listed, the sample project.
Click on the project and check that you can navigate to the
Backlog, Wall and Completed pages. Experiment with creating
features and stories and verify that you can move them through
all their phases.</P>
<H1>The project configuration</H1>
<P>We don't have a configuration UI at this stage, so to set up
a project you need to copy an existing project or build the
project structure and create a kanban.properties file by hand:</P>
<PRE><kanban home>/<project name>/kanban.properties</PRE>
<H2>Declare the work-item types</H2>
<P>The work item types are the categories of work item like
features and stories. You declare them like this:</P>
<PRE>workItemTypes=feature,story </PRE>
<H2>Configure the work-item types</H2>
<P>Then, for each work item type you specify its parent, its
phases and the colours to use on the web page:</P>
<PRE>workItemTypes.feature.parent=root
workItemTypes.feature.phases=Backlog,Design,Implement,Accept,Complete
workItemTypes.feature.cardColour=6698FF
workItemTypes.feature.backgroundColour=C6DEFF
workItemTypes.story.parent=feature
workItemTypes.story.phases=Development,Test
workItemTypes.story.cardColour=ECD672
workItemTypes.story.backgroundColour=FAF8CC</PRE>
<P>The "parent" property creates a hierarchy. In this
case, stories are subtypes of features and features are the root
work item type.</P>
<H2>Configure the board phases</H2>
<P>Finally you specify which phases should appear on the Wall
and Completed boards:</P>
<PRE>boards.wall=Design,Implement,Development,Test,Accept
boards.completed=Complete</PRE>
<P>So in this case the "wall" board contains phases
for both features and stories, but the "completed"
board only contains features. The "backlog" board only
ever contains the top-level work items (i.e. features), and it
is hard-coded to list items in the first phase in the sequence
(in our example, the Backlog phase).</P>
<P>There are error messages in the stack trace if the project
configuration is wrong. Hopefully these are pretty clear.</P>
<P>
</BODY>
</HTML>