honeymap-master/README.md

   1 HoneyMap
   2 ========
   3
   4 HoneyMap is a web application which displays a live stream of
   5 GPS locations on a SVG world map. It makes use of
   6 [jQuery](http://jquery.com/),
   7 [node.js](http://nodejs.org/),
   8 [socket.io](http://socket.io/) (HTML5 websockets),
   9 [jVectorMap](http://jvectormap.com/) and
  10 [jQuery Transit](http://ricostacruz.com/jquery.transit/) for CSS3 animations.
  11
  12 In principle, it can be used with any stream of GPS data. For our application,
  13 we use honeypot captures, provided by several [hpfeeds](https://github.com/rep/hpfeeds)
  14 from the [Honeynet Project](http://www.honeynet.org/).
  15
  16 Tested with node.js v0.8.9 and socket.io v0.9.10.
  17
  18 Example
  19 -------
  20 * [http://map.honeycloud.net/](http://map.honeycloud.net/)
  21
  22 Requirements
  23 ------------
  24 * `npm install node-static`
  25 * `npm install socket.io`
  26 * `npm install validator`
  27
  28 Browser support
  29 ---------------
  30 Should work with current Chrome and Firefox browsers.
  31 Opera, Safari and IE not tested yet.
  32
  33 License
  34 -------
  35 GNU Lesser General Public License (LGPL), see
  36 [LICENSE](http://github.com/fw42/honeymap/blob/master/LICENSE).
  37
  38 Authors
  39 -------
  40 * [Florian Weingarten](mailto:flo@hackvalue.de) ([fw42](http://github.com/fw42/))
  41 * [Mark Schloesser](mailto:mark.schloesser@rwth-aachen.de) ([rep](http://github.com/rep/))
  42
  43 TODO
  44 ----
  45 * Make maximal number of visible markers configurable by user
  46 * "Replay" feature (load last x hours from server)
  47 * Browser compatibility (only Webkit and Firefox right now; No Mobile browsers)