5 This is the source code for Frank, a simple Java Servlet that
6 will query the OC Transpo (www.octranspo.com) GPS data API.
8 Frank uses parts of QuanDocs, which is released under the GPL
9 (GNU Public Licence version 3 or, at your option, any later
10 version) and, thus, Frank is also available under GPLv3-or-later.
11 Please see the file COPYING for the full terms of this licence.
17 Frank's production code depends on the following external libraries:
19 - Jenkins-WinStone (LGPL, Debian package libjenkins-winstone-java)
20 You could substitute a different servlet engine if you modif go.sh
21 - Apache HttpComponents 4.3 (Apache Licence, packaged with Frank
22 because as of this writing Debian stable doesn't yet provide it)
24 The Unit Tests (invoked via cov.sh) rely on a couple of additional
27 - JUnit 4 (Eclipse Public Licence, Debian package junit4)
28 the same reason as HttpComponents 4.3)
29 - Oracle jcov (GPLv2 + classpath exception, also packaged with
30 Frank because Debian doesn't yet include it)
32 If you are not building on Debian Linux, then you'll need to
33 download WinStone and JUnit4 separately, and edit setcp.sh to
34 point to the correct paths.
40 To build the source code, run its unit tests, and generate
41 a code coverage report:
45 $ www-browser ./report/index.html
47 To build the source code and run it in the WinStone Servlet Engine:
52 Note that the OC Transpo server will refuse to answer unless you have
53 a valid AppID + APIKey combination, but my APIKey is not included in this
54 source distribution. You'll need to get your own from octranspo.com.