149 lines
5.8 KiB
Markdown
Executable File
149 lines
5.8 KiB
Markdown
Executable File
[](https://travis-ci.org/okfn/recline)
|
|
|
|
A simple but powerful library for building data applications in pure Javascript and HTML.
|
|
|
|
<h3><a href="http://okfnlabs.org/recline/">Recline Website - including Overview, Documentation, Demos etc</a></h3>
|
|
|
|
## Features
|
|
|
|
* Open-source (and heavy reuser of existing open-source libraries)
|
|
* Pure javascript (no Flash) and designed for integration -- so it is easy to
|
|
embed in other sites and applications
|
|
* View and edit your data in clean grid interface
|
|
* Bulk update/clean your data using an easy scripting UI
|
|
* Visualize your data
|
|
* And more ... see <http://okfnlabs.org/recline/>
|
|
|
|
## Contributing
|
|
|
|
See CONTRIBUTING.md.
|
|
|
|
### Contributors
|
|
|
|
* [Rufus Pollock](http://rufuspollock.org/)
|
|
* [Max Ogden](http://maxogden.com/)
|
|
* [John Glover](https://github.com/johnglover)
|
|
* [James Casbon](http://casbon.me/)
|
|
* [Adrià Mercader](http://amercader.net/)
|
|
* [Dominik Moritz](https://github.com/domoritz)
|
|
* [Friedrich Lindenberg](http://pudo.org/)
|
|
* [Alioune Dia](https://github.com/aliounedia)
|
|
* [kielni](https://github.com/kielni)
|
|
* And [many more](https://github.com/okfn/recline/graphs/contributors)
|
|
|
|
## Changelog
|
|
|
|
|
|
### v0.7 - Summer 2014 (tbc)
|
|
|
|
[v0.7 milestone](https://github.com/okfn/recline/issues?milestone=7)
|
|
|
|
Possible breaking changes
|
|
|
|
* Support for row/add/delete/Reorder for recline slickGrid check `_includes/recline-deps.html` for slcikGrid plugins required #396
|
|
* Upgraded timelinejs lib - #316
|
|
* Removed csv backend (as now in separate repo) #444
|
|
|
|
### v0.6 - Summer 2013
|
|
|
|
[v0.6 milestone](https://github.com/okfn/recline/issues?milestone=5) (more than 40 issues)
|
|
|
|
Possible breaking changes
|
|
|
|
* Many backends moved to their own repositories #314
|
|
* Upgarde to Backbone v1.0 #351
|
|
* Updated Leaflet to latest version 0.4.4 #220
|
|
* Added marker clustering in map view to handle a large number of markers (and allowed it to disabled)
|
|
* Dataset.restore method removed (not used internally except from Multiview.restore)
|
|
* Views no longer call render in initialize but must be called client code
|
|
* Backend.Memory.Store attribute for holding 'records' renamed to `records` from `data`
|
|
* Option to use underscore.deferred vendor library and not use jQuery (jQuery no longer required if just using recline.dataset.js)
|
|
* View.el is now the raw DOM element. If you want a jQuery-wrapped version, use view.$el. #350
|
|
* Pager widget now takes Dataset object rather than QueryState object #386
|
|
|
|
### v0.5 - July 5th 2012 (first public release)
|
|
|
|
[40 closed issues](https://github.com/okfn/recline/issues?milestone=2&page=1&state=closed)
|
|
|
|
Lots of breaking changes to the API from v0.4 (should be very few going forwards) including:
|
|
|
|
* State only stores backend (name) and dataset url (in url field) rather than entire dataset object
|
|
* Backends heavily reorganized
|
|
* Rename Document -> Record
|
|
* Rename DataExplorer view to MultiView
|
|
* ...
|
|
|
|
### v0.4 - April 26th 2012
|
|
|
|
[23 closed issues](https://github.com/okfn/recline/issues?milestone=2&page=1&state=closed) including:
|
|
|
|
* Map view using Leaflet - #69, #64, #89, #97
|
|
* Term filter support - #66
|
|
* Faceting support- #62
|
|
* Tidy up CSS and JS - #81 and #78
|
|
* Manage and serialize view and dataset state (plus support for embed and permalinks) - #88, #67
|
|
* Graph view improvements e.g. handle date types correctly - #75
|
|
* Write support for ES backend - #61
|
|
* Remove JQuery-UI dependency in favour of bootstrap modal - #46
|
|
* Improved CSV import support - #92
|
|
|
|
### v0.3 - March 31st 2012
|
|
|
|
[16 closed issues](https://github.com/okfn/recline/issues?milestone=1&state=closed) including:
|
|
|
|
* ElasticSearch (and hence DataHub/CKAN) backend - #54
|
|
* Loading of local CSV files - #36
|
|
* Fully worked out Data Query support - #34, #49, #53, #57
|
|
* New Field model object for richer field information - #25
|
|
* Upgrade to Bootstrap v2.0 - #55
|
|
* Recline Data Explorer app improvements e.g. #39 (import menu)
|
|
* Graph improvements - #58 (more graph types, graph interaction)
|
|
|
|
### v0.2 - Feb 24th 2012
|
|
|
|
[17 closed issues](https://github.com/okfn/recline/issues?milestone=3&state=closed) including:
|
|
|
|
* Major refactor of backend and model relationship - #35 and #43
|
|
* Support Google Docs Spreadsheets as a Backend - #15
|
|
* Support for online CSV and Excel files via DataProxy backend - #31
|
|
* Data Explorer is customizable re loaded views - #42
|
|
* Start of documentation - #33
|
|
* Views in separate files - #41
|
|
* Better error reporting from backends on JSONP errors - #30
|
|
* Sorting and show/hide of columns in data grid - #23, #29
|
|
* Support for pagination - #27
|
|
* Split backends into separate files to make them easier to maintain and reuse separately #50
|
|
|
|
### v0.1 - Jan 28th 2012
|
|
|
|
* Core models and structure including Dataset and Document
|
|
* Memory and webstore backends
|
|
* Grid, Graph and Data Explorer views
|
|
* Bootstrap-based theme - #22
|
|
|
|
## Copyright and License
|
|
|
|
Copyright 2011 Max Ogden and Rufus Pollock.
|
|
|
|
Licensed under the MIT license:
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
|
|
|