datahub/download.markdown

113 lines
3.8 KiB
Markdown

---
layout: container
title: Download
---
<div class="page-header">
<h1>
Download Recline
</h1>
</div>
<h2>Latest Code - Master</h2>
<p>The tutorials on this website will usually be based on the latest (master) codebase. It should also be very stable.</p>
<div class="row">
<div class="span4">
<a href="dist/recline.js" class="btn">
<strong>recline.js (master) &raquo;</strong>
<br />
Single file containing all of Recline library
</a>
</div>
<div class="span4">
<a href="dist/recline.dataset.js" class="btn">
<strong>recline.dataset.js (master) &raquo;</strong>
<br />
Single file with only the core data objects Dataset, Record etc without any Views or backends
</a>
</div>
<div class="span4">
<a href="https://github.com/okfn/recline/zipball/master" class="btn">
<strong>Full package (master) &raquo;</strong>
<br />
Everything - library, source code, unit tests, vendor libraries and documentation
</a>
</div>
</div>
<h2>Most Recent Official Release &ndash; v0.5</h2>
<div class="row">
<div class="span4">
<a href="https://raw.github.com/okfn/recline/v0.5/dist/recline.js" class="btn">
<strong>recline.js &raquo;</strong>
<br />
Single file containing all of Recline library
</a>
</div>
<div class="span4">
<a href="https://raw.github.com/okfn/recline/v0.5/dist/recline.dataset.js" class="btn">
<strong>recline.dataset.js &raquo;</strong>
<br />
Single file with only the core data objects Dataset, Record etc without any Views or backends
</a>
</div>
<div class="span4">
<a href="https://github.com/okfn/recline/zipball/v0.5" class="btn">
<strong>Full package (master) &raquo;</strong>
<br />
Everything - library, source code, unit tests, vendor libraries and documentation
</a>
</div>
</div>
<p style="margin-top: 20px;">After downloading recline you'll want to use it in your project -- see below or tutorials for details.</p>
### Changelog
[View Changelog on Github](https://github.com/okfn/recline#changelog)
### Dependencies
Recline has dependencies on some third-party libraries. Specifically, recline.dataset.js depends on:
* [Underscore](http://documentcloud.github.com/underscore/) &gt;= 1.0
* [Underscore Deferred](https://github.com/wookiehangover/underscore.deferred) v0.4.0
* [Backbone](http://backbonejs.org/) >= 0.5.1
Those backends which utilize jquery's ajax method depend on jQuery:
* [JQuery](http://jquery.com/) >= 1.6
All the views require, in addition to those needed for recline.dataset.js:
* [JQuery](http://jquery.com/) >= 1.6
* [Mustache.js](https://github.com/janl/mustache.js/) &gt;= 0.5.0-dev (required for all views)
Individual views have additional dependencies such as:
* [JQuery Flot](http://www.flotcharts.org/) >= 0.7 (required for for graph view)
* [Leaflet](http://leaflet.cloudmade.com/) >= 0.4.4 (required for map view)
* [Leaflet.markercluster](https://github.com/danzel/Leaflet.markercluster) as of 2012-09-12 (required for marker clustering)
* [Verite Timeline](https://github.com/VeriteCo/Timeline/) as of 2012-05-02 (required for the timeline view)
* [Bootstrap](http://twitter.github.com/bootstrap/) &gt;= v2.0 (default option for CSS and UI JS but you can use your own)
If you grab the full zipball for Recline this will include all of the relevant
dependencies in the vendor directory and you can also find them at in the
[github repo here](https://github.com/okfn/recline/tree/master/vendor).
### Example
Here is an example of the page setup for an app using every Recline component:
{% highlight html %}
<!-- bootstrap -->
<!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link rel="stylesheet" href="vendor/bootstrap/2.0.2/css/bootstrap.css" />
{% include recline-deps.html %}
{% endhighlight %}