The datablog-ui implementation allows editing text, images, and two kinds of map elements directly in the browser. It is the accompanying code repository for the livingmap, a Harvard University Extension School master thesis. A public demo page of this project can be found at datablog.io. The thesis document is at https://s3.amazonaws.com/datablog-assets/Gabriel-Hase-thesis-the-livingmap.pdf.
If you care about the map elements, i.e. choropleths and web maps, you will likely need to dive into the code and integrate them with your code respectively. Web maps are created with the angular-leaflet-directive, which is an awesome open source stand-alone directive for interactive maps. You probably want to start there and see how the datablog-ui integrates the directive into an editing environment with forms and modals. The choropleth maps are supported with a custom directive that can be found in the code's directives folder.
If you care about the text editing and drag&drop capabilities, you need the software library livingdocs, which is open source under the LGPL, and can be donwloaded here.
- Install node and npm, node.js
- From the top directory, run
npm install
You can run the server in both local and api mode. Out of the box, only the local mode is supported, which is also the default. If you want to save your documents to a server, you will need to implement the API layer found in components/api.
So to run the server in local mode use either:
grunt server
or
grunt server --api=local
If you want to run it with your own API (requires that you implement the api layer) then run:
grunt server --api=<name of your api>
The specs are pretty slow. I am sorry... To run them, type:
grunt test
The build task creates the dist folder for you. You can then take this folder and deploy it anywhere you like (the datablog.io demo page uses github pages).
To build the project, run:
grunt build
NOTE: The build task will by default use the API layer. If you want to build a local version, e.g. to have a demo page that stores to the browsers local storage, run:
grunt build --api=local
No code is an island! The datablog-ui project builds upon a lot of really awesome tools and libraries. Below is a list of all of them (please tell me, if I forgot something):
| name | webpage | licence |
|---|---|---|
| JQuery | http://www.jquery.com | MIT |
| Angular.JS | http://www.angularjs.org | MIT |
| d3.js | http://www.d3js.org | custom |
| d3-geo-projection | https://github.com/d3/d3-geo-projection/ | custom |
| leaflet.js | http://leafletjs.com/ | custom |
| livingdocs | http://www.livingdocs.io | LGPL |
| moment.js | http://momentjs.com/ | custom |
| underscore.js | http://underscorejs.org/ | custom |
| ng-grid | http://angular-ui.github.io/ng-grid/ | MIT |
| ng-progress | http://victorbjelkholm.github.io/ngProgress/ | MIT |
| UI Bootstrap | http://angular-ui.github.io/bootstrap/ | MIT |
| angular-truncate | https://github.com/sparkalow/angular-truncate | MIT |
| name | webpage | licence |
|---|---|---|
| colorbrewer | https://github.com/mbostock/d3/tree/master/lib/colorbrewer | Apache |
| GADM maps | http://www.gadm.org/ | non-commercial use only |
| bootstrap | http://getbootstrap.com/ | MIT |
Copyright 2014 Gabriel Hase, gabriel(dot)hase(at)gmail(dot)com
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.
NOTE: This licence does not include third-party libraries. Please check the Credits section of the README.md file for details.