https://cartodb.github.io/odyssey.js/

Making it easy to merge map and narrative
https://cartodb.github.io/odyssey.js/

Last synced: 13 days ago
JSON representation

Making it easy to merge map and narrative

• Host: GitHub
• URL: https://cartodb.github.io/odyssey.js/
• Owner: CartoDB
• License: bsd-3-clause
• Created: 2014-01-22T19:14:46.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-12-09T15:32:44.000Z (almost 9 years ago)
• Last Synced: 2024-10-29T17:54:56.432Z (14 days ago)
• Language: JavaScript
• Size: 17.2 MB
• Stars: 1,617
• Watchers: 105
• Forks: 187
• Open Issues: 55
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-datascience - cartodb

README

        
## About

The odyssey.js library is being developed to help journalists, bloggers, and other people on the web publish stories that combine narratives with maps and map interactions. The library is open source and freely available to use in your projects. It is initially being built to work with most modern browsers.

[![Build Status](https://travis-ci.org/CartoDB/odyssey.js.svg?branch=master)](https://travis-ci.org/CartoDB/odyssey.js)

## Goals

* Create a simple JavaScript library that links page elements to slippy map interactions

* Provide an API interface to the JavaScript library that makes use and customization easy

* Prototype and test multiple map interaction methods for storytelling

* Develop basic interface for creating new documents using the odyssey.js library

## Status

* Project launched, 23/01/2014

* Javascript library tested, 17/02/2014

* Core map actions added, 27/02/2014

* Designed/added init templates, 11/03/2014

* Added initial editor, 12/03/2014

* Added intro docs, 17/03/2014

* Documentation section, 5/06/2014

* Updated editor, 10/06/2014

* Renamed editor => sandbox, 27/06/2014

* Official release, 9/07/2014

## Live sandbox, Documentation and Examples

Jump directly into:

* [the live sandbox](http://cartodb.github.io/odyssey.js/index.html)

* [documentation](http://cartodb.github.io/odyssey.js/documentation) 

* [some examples](http://cartodb.github.io/odyssey.js/documentation/#the-odyssey-sandbox) 

## Contributing

If you are interested in helping us develop the project, see [CONTRIBUTING](CONTRIBUTING.md) for more information.

## License 

Odyssey.js is available under a [BSD 3-clause license](LICENSE)

## Support

Odyssey.js was made possible by a grant from the Knight Foundation.