All deck.gl examples are set up to be "stand-alone", which means that
you can copy the example folder to your own environment, run yarn or npm install
and npm start and within minutes have a running, minimal app that you can
start modifying and experimenting with.
These are intended to be absolutely minimal (in terms of application code, package.json, bundler config etc) examples of how to get deck.gl and a base map working together.
- Pure JS Applications without depending any additional framework. Bundled and served with Vite.
- React React examples using
@deck.gl/reactandreact-map-gl. Bundled and served with Vite. - Scripting HTML single-file examples that can be opened directly in a browser.
These are stand-alone versions of the examples in the deck.gl website, with smaller uncompressed data sets to make it easy to understand how they work.
This is the deck.gl
playground demo, showcasing declaratively defining layers using @deck.gl/json.
This contains the source of the deck.gl gallery page, showcasing scripting with pre-bundled deck.gl modules.
The Layer Browser enables testing of props for all official layers and effects. This is the main example used for testing layers during development of deck.gl.
These are examples that use experimental deck.gl features, or implement features that we consider adding to the deck.gl API. We think they are useful to advanced users, but not yet mature enough to be an "official" example on the website.
Most example apps can be run by installing the dependencies with either yarn or with npm install, then npm run start. Refer to the README in each example directory for app-specific instructions.
Most examples are set up so that they can be run either against the local source code (enabling debugging of deck.gl itself, with hot reloading) or against an installed version of deck.gl (enables testing that things work with the published version).
Examples that support this mode have a start-local script in their
package.json.