Demo App

This is the src code of kepler.gl demo app. You can copy this folder out and run it locally.

Pre requirement

• Node.js ^18.x: We use Node to generate the documentation, run a development web server, run tests, and generate distributable files. Depending on your system, you can install Node either from source or as a pre-packaged bundle.

• Yarn 4.4.0: We use Yarn to install our Node.js module dependencies (rather than using npm). See the detailed installation instructions.

1. Install Dependencies

Go to the root directory and install the dependencies using yarn:

yarn bootstrap

If install fails while building the gl package, use Node 18.18.2 from the repo root .nvmrc (nvm install / nvm use), or see Troubleshooting: gl package install.

If yarn start errors with missing @kepler.gl/duckdb/components (or other workspace dist/ files), from the repo root run yarn workspaces foreach -At run stab or run full yarn bootstrap (not only yarn install).

Then, go to the examples/demo-app directory and install the dependencies using yarn:

yarn install

2. Environment Variables

Create a .env file at the root directory by copying from .env.template:

cp .env.template .env

Then update the following environment variables in your .env file:

MAPBOX_ACCESS_TOKEN=<your_mapbox_token>
DROPBOX_CLIENT_ID=<your_dropbox_client_id>
MAPBOX_EXPORT_TOKEN=<your_mapbox_export_token>
CARTO_CLIENT_ID=<your_carto_client_id>
FOURSQUARE_CLIENT_ID=<your_foursquare_client_id>
FOURSQUARE_DOMAIN=<your_foursquare_domain>
FOURSQUARE_USER_MAPS_URL=<your_foursquare_user_map_url>

3. Start the app

yarn start:local