timetraveller
v1.0.1
Published
Webservice to explore spatio-temporal data in an interactive way
Downloads
6
Maintainers
Readme
Timetraveller
Webservice to explore spatio-temporal data in an interactive way.
Installation
git clone https://github.com/fnogatz/timetraveller.git
cd timetraveller
npm install
Maps
The available maps are configured by YAML files in the /maps
directory. Simply copy the provided example.yml
and change it to fit your needs.
Creation
Create a new YAML file in the /maps
directory. The filename will be map's identifier. That means if you save a my-map.yml
, this map will be accessable as http://domain.tld/my-map
.
A step-by-step guidance to import and display GTFS transit data can be found in the wiki.
Server
You can start the webserver by calling:
npm start
Model Connectors
This is a list of currently available connectors.
- timetraveller-mongodb: Connector for MongoDB
Write your own
The timetraveller server can use any data source. A Connector
object is used to access your data. It only has to provide the following signature:
// Constructor
var connector = new Connector(options)
// Method to find trajectories
connector.findTrajectories(query)
/**
* Search parameters:
*
* query.time.start (Start of time range)
* query.time.end (End of time range)
* query.bounds.east (Bounding Box)
* query.bounds.west
* query.bounds.north
* query.bounds.south
*/
Have a look at timetraveller-mongodb for a working connector example.