dotkrnl / moves-on-deck

A WebGL-powered visualization of Moves app location history built on the deck.gl framework

Moves On Deck

Moves On Deck is a WebGL-powered visualization of your Moves app location history, built with React and Uber's deck.gl framework.

Usage

This project is currently available at https://apps.claygregory.com/moves-on-deck/. Data processing is entirely client-side in browser, so there's no need to deploy your own copy if just interested as an end-user.

Development

If you're interested in local development, the provided Gulpfile will allow you build and run your own copy. However, you'll need to supply your own Mapbox API key.

Setup

From the project root, install the required dependencies with either NPM or Yarn:

npm install

or

yarn

Environmental Variables

To use the Mapbox layer, you'll need to supply the your own Mapbox API key, via the MAPBOX_ACCESS_TOKEN environmental variable. This can be provided on the command line, or placed in a .env file at the project root. Your can request a free key from Mapbox for limited usage.

Running Locally

By default, Gulp will build the project and launch a local webserver on port 8000 with hot-reloading enabled. Be sure you've provided the Mapbox API key as described above.

MAPBOX_ACCESS_TOKEN=your_token gulp

Production Build

As with a dev build, you'll need to supply a Mapbox API key as described above. This key will be statically inlined to your production build using envify, ready for distribution. Running with --type=production will also compress and uglify the build:

MAPBOX_ACCESS_TOKEN=your_token gulp --type=production build

The contents of the dist directory are then ready to deploy to a static web server.

License

See the included LICENSE for rights and limitations under the terms of the MIT license.