Permalink
Browse files

A little bit of documentation...

... everyone writes documentation when it's
actually self promotion ;)
  • Loading branch information...
1 parent 0278092 commit a25882f59fc05c6ac0829462b154500e9eddd4ad @tackley committed Sep 18, 2011
Showing with 42 additions and 0 deletions.
  1. +40 −0 readme.md
  2. +2 −0 src/main/webapp/index.html
View
@@ -0,0 +1,40 @@
+Where in the World?
+===================
+
+This project is a quick experiment to see whether a maps-style interface can improve accessiblity of
+some of the Guardian's travel writing. Some of the content is already geo-tagged, so this app just
+takes those geotags and links to the articles from a google map. It scans for new content in the API
+and will include that automatically, though Google heavily cache the map overlays so I'm not sure what
+the latency is yet.
+
+The Tech
+--------
+
+There are around [33,000 items of guardian content tagged travel](http://content.guardianapis.com/travel/travel),
+though many of these are not geotagged.
+
+The API only lets you query for 50 at once, and cannot (currently) filter on only geotagged items.
+
+So, a background process scans for modified content, and maintains a database in MongoDB. The runtime app
+uses this database to build a [KML file](http://code.google.com/apis/kml/documentation/)
+that [Google Maps can use as an overlay](http://code.google.com/apis/maps/documentation/javascript/overlays.html#KMLLayers)
+
+The app itself is implemented in Scala, using [akka](http://akka.io) for background scheduling,
+[casbah](https://github.com/mongodb/casbah)
+and [salat](https://github.com/novus/salat) to talk to mongo, [the lift web framework](http://liftweb.net) and the Guardian's
+[Content API scala client](https://github.com/guardian/open-platform-content-api-scala-client).
+
+Right now, it's hosted - for free - by [CloudBees](http://www.cloudbees.com) and [MongoHQ](http://mongohq.com).
+You can see it running at [here](http://travel-map.tackers.cloudbees.net/).
+
+
+Important Disclaimer
+-------------------
+
+Although I work for the Guardian, and helped implement the Open Platform Content API, this
+is entirely a personal project and has no connection at all with the Guardian.
+
+
+
+
+
@@ -42,6 +42,8 @@
</a> is powered by <a href="http://www.guardian.co.uk">The Guardian's</a>
<a href="http://content.guardianapis.com">Open Platform Content API</a>.
+ Written by Graham Tackley, source code and more information on <a href="https://github.com/tackley/travel-map">github</a>.
+
</footer>
</div>

0 comments on commit a25882f

Please sign in to comment.