Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

[example] Kepler.gl getting started example with Vite (#3123)

Igor Dykhta4fd570c3eae2
diff --git a/examples/get-started-vite/README.md b/examples/get-started-vite/README.md
new file mode 100644
index 000000000..f99e6870f
--- /dev/null
+++ b/examples/get-started-vite/README.md
@@ -0,0 +1,32 @@
+# Kepler.gl with Vite
+
+This example uses [Kepler.gl](https://kepler.gl/) with Vite as the build tool.
+
+## Development
+
+### Installation
+
+```bash
+# Install dependencies
+yarn install
+```
+
+### Development Server
+
+To start the development server with hot module replacement:
+
+```bash
+yarn dev
+```
+
+### Production Build
+
+To create a production build and preview it:
+
+```bash
+# Create production build
+yarn build
+
+# Preview production build
+yarn preview
+```
diff --git a/examples/get-started-vite/eslint.config.js b/examples/get-started-vite/eslint.config.js
new file mode 100644
index 000000000..092408a9f
--- /dev/null
+++ b/examples/get-started-vite/eslint.config.js
@@ -0,0 +1,28 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+ { ignores: ['dist'] },
+ {
+ extends: [js.configs.recommended, ...tseslint.configs.recommended],
+ files: ['**/*.{ts,tsx}'],
+ languageOptions: {
+ ecmaVersion: 2020,
+ globals: globals.browser,
+ },
+ plugins: {
+ 'react-hooks': reactHooks,
+ 'react-refresh': reactRefresh,
+ },
+ rules: {
+ ...reactHooks.configs.recommended.rules,
+ 'react-refresh/only-export-components': [
+ 'warn',
+ { allowConstantExport: true },
+ ],
+ },
+ },
+)
diff --git a/examples/get-started-vite/index.html b/examples/get-started-vite/index.html
new file mode 100644
index 000000000..596811b31
--- /dev/null
+++ b/examples/get-started-vite/index.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Kepler + Vite</title>
+ </head>
+ <body>
+ <div id="root"></div>
+ <script type="module" src="/src/main.tsx"></script>
+ </body>
+</html>
diff --git a/examples/get-started-vite/package.json b/examples/get-started-vite/package.json
new file mode 100644
index 000000000..2ab3d84e1
--- /dev/null
+++ b/examples/get-started-vite/package.json
@@ -0,0 +1,66 @@
+{
+ "name": "kepler-app-vite",
+ "version": "0.0.1",
+ "license": "MIT",
+ "scripts": {
+ "dev": "vite",
+ "build": "tsc -b && vite build",
+ "preview": "vite preview"
+ },
+ "dependencies": {
+ "@babel/runtime": "^7.12.1",
+ "@deck.gl/aggregation-layers": "^8.9.27",
+ "@deck.gl/core": "^8.9.27",
+ "@deck.gl/extensions": "^8.9.27",
+ "@deck.gl/geo-layers": "^8.9.27",
+ "@deck.gl/layers": "^8.9.27",
+ "@deck.gl/mesh-layers": "^8.9.27",
+ "@dnd-kit/core": "^6.1.0",
+ "@dnd-kit/modifiers": "^7.0.0",
+ "@dnd-kit/sortable": "^8.0.0",
+ "@kepler.gl/components": "3.1.7",
+ "@kepler.gl/reducers": "3.1.7",
+ "@loaders.gl/arrow": "4.3.2",
+ "@loaders.gl/core": "4.3.2",
+ "@loaders.gl/gltf": "4.3.2",
+ "@loaders.gl/images": "4.3.2",
+ "@loaders.gl/mvt": "4.3.2",
+ "@loaders.gl/parquet": "4.3.2",
+ "@loaders.gl/pmtiles": "4.3.2",
+ "@luma.gl/core": "8.5.21",
+ "@luma.gl/engine": "8.5.21",
+ "@luma.gl/gltools": "8.5.21",
+ "@luma.gl/shadertools": "8.5.21",
+ "@luma.gl/webgl": "8.5.21",
+ "@math.gl/core": "^4.0.0",
+ "@math.gl/web-mercator": "^3.6.2",
+ "apache-arrow": "17.0.0",
+ "gl-matrix": "^3.4.3",
+ "lodash": "4.17.21",
+ "react": "^18.2.0",
+ "react-dom": "^18.2.0",
+ "react-redux": "^8.0.5",
+ "react-scripts": "^5.0.1",
+ "react-virtualized": "^9.22.5",
+ "redux": "^4.2.1"
+ },
+ "devDependencies": {
+ "@eslint/js": "^9.25.0",
+ "@types/lodash.uniq": "^4",
+ "@types/node": "^22.15.21",
+ "@types/react": "^19.1.2",
+ "@types/react-dom": "^19.1.2",
+ "@vitejs/plugin-react": "^4.4.1",
+ "eslint": "^9.25.0",
+ "eslint-plugin-react-hooks": "^5.2.0",
+ "eslint-plugin-react-refresh": "^0.4.19",
+ "globals": "^16.0.0",
+ "typescript": "~5.8.3",
+ "typescript-eslint": "^8.30.1",
+ "vite": "^6.3.5",
+ "vite-plugin-wasm": "^3.4.1"
+ },
+ "resolutions": {
+ "apache-arrow": "17.0.0"
+ }
+}
diff --git a/examples/get-started-vite/src/main.tsx b/examples/get-started-vite/src/main.tsx
new file mode 100644
index 000000000..1203c4568
--- /dev/null
+++ b/examples/get-started-vite/src/main.tsx
@@ -0,0 +1,71 @@
+import React, {Dispatch} from 'react';
+import ReactDOM from 'react-dom/client';
+import {connect, Provider} from 'react-redux';
+
+import {applyMiddleware, combineReducers, compose, createStore} from 'redux';
+
+import KeplerGl from '@kepler.gl/components';
+import keplerGlReducer, {enhanceReduxMiddleware, KeplerGlState} from '@kepler.gl/reducers';
+
+import AutoSizer from 'react-virtualized/dist/commonjs/AutoSizer';
+
+// create reducers
+const reducers = combineReducers({
+ // mount keplerGl reducer
+ keplerGl: keplerGlReducer.initialState({
+ uiState: {
+ readOnly: false,
+ currentModal: null
+ }
+ })
+});
+
+// create middlewares
+const middleWares = enhanceReduxMiddleware([
+ // Add other middlewares here
+]);
+
+// craeteEnhancers
+const enhancers = applyMiddleware(...middleWares);
+
+// create store
+const initialState = {};
+const store = createStore(reducers, initialState, compose(enhancers));
+
+const App = () => (
+ <div
+ style={{
+ position: 'absolute',
+ top: '0px',
+ left: '0px',
+ width: '100%',
+ height: '100%'
+ }}
+ >
+ <AutoSizer>
+ {({height, width}) => (
+ <KeplerGl
+ mapboxApiAccessToken="pk.eyJ1IjoiaWdvcjEzMTMxMyIsImEiOiJjbTRtMWxoMnIwN3VhMmlxOGRnZ3AxcGhhIn0.d9YD6z5nsBNzPXrXWzIaAA"
+ id="map"
+ width={width}
+ height={height}
+ />
+ )}
+ </AutoSizer>
+ </div>
+);
+
+const mapStateToProps = (state: KeplerGlState) => state;
+const dispatchToProps = (dispatch: Dispatch<any>) => ({dispatch});
+const ConnectedApp = connect(mapStateToProps, dispatchToProps)(App);
+const Root = () => (
+ <Provider store={store}>
+ <ConnectedApp />
+ </Provider>
+);
+
+const container = document.getElementById('root');
+if (container) {
+ const root = ReactDOM.createRoot(container);
+ root.render(<Root />);
+}
diff --git a/examples/get-started-vite/tsconfig.json b/examples/get-started-vite/tsconfig.json
new file mode 100644
index 000000000..7e4a3307d
--- /dev/null
+++ b/examples/get-started-vite/tsconfig.json
@@ -0,0 +1,22 @@
+{
+ "compilerOptions": {
+ "target": "ESNext",
+ "useDefineForClassFields": true,
+ "lib": ["DOM", "DOM.Iterable", "ESNext"],
+ "allowJs": false,
+ "skipLibCheck": true,
+ "esModuleInterop": true,
+ "allowSyntheticDefaultImports": true,
+ "strict": true,
+ "forceConsistentCasingInFileNames": true,
+ "module": "ESNext",
+ "moduleResolution": "bundler",
+ "resolveJsonModule": true,
+ "isolatedModules": true,
+ "noEmit": true,
+ "jsx": "react-jsx",
+ "types": ["node"]
+ },
+ "include": ["src"],
+ "references": [{ "path": "./tsconfig.node.json" }]
+}
diff --git a/examples/get-started-vite/tsconfig.node.json b/examples/get-started-vite/tsconfig.node.json
new file mode 100644
index 000000000..97ede7ee6
--- /dev/null
+++ b/examples/get-started-vite/tsconfig.node.json
@@ -0,0 +1,11 @@
+{
+ "compilerOptions": {
+ "composite": true,
+ "skipLibCheck": true,
+ "module": "ESNext",
+ "moduleResolution": "bundler",
+ "allowSyntheticDefaultImports": true,
+ "strict": true
+ },
+ "include": ["vite.config.ts"]
+}
diff --git a/examples/get-started-vite/vite.config.ts b/examples/get-started-vite/vite.config.ts
new file mode 100644
index 000000000..1f45830f3
--- /dev/null
+++ b/examples/get-started-vite/vite.config.ts
@@ -0,0 +1,110 @@
+import { defineConfig } from "vite";
+import react from "@vitejs/plugin-react";
+import wasm from "vite-plugin-wasm";
+import { resolve } from "path";
+
+// https://vitejs.dev/config/
+export default defineConfig({
+ plugins: [wasm(), react()],
+ server: {
+ port: 8081,
+ open: true,
+ },
+ build: {
+ outDir: "dist",
+ sourcemap: false,
+ minify: true,
+ rollupOptions: {
+ input: {
+ main: resolve(__dirname, "index.html"),
+ },
+ },
+ target: "esnext",
+ commonjsOptions: {
+ include: [/node_modules/],
+ transformMixedEsModules: true,
+ },
+ },
+ define: {
+ "process.env.NODE_ENV": JSON.stringify(
+ process.env.NODE_ENV || "production"
+ ),
+ "process.env.MapboxAccessToken": JSON.stringify(
+ process.env.MapboxAccessToken || ""
+ ),
+ "process.env.DropboxClientId": JSON.stringify(
+ process.env.DropboxClientId || ""
+ ),
+ "process.env.MapboxExportToken": JSON.stringify(
+ process.env.MapboxExportToken || ""
+ ),
+ "process.env.CartoClientId": JSON.stringify(
+ process.env.CartoClientId || ""
+ ),
+ "process.env.FoursquareClientId": JSON.stringify(
+ process.env.FoursquareClientId || ""
+ ),
+ "process.env.FoursquareDomain": JSON.stringify(
+ process.env.FoursquareDomain || ""
+ ),
+ "process.env.FoursquareAPIURL": JSON.stringify(
+ process.env.FoursquareAPIURL || ""
+ ),
+ "process.env.FoursquareUserMapsURL": JSON.stringify(
+ process.env.FoursquareUserMapsURL || ""
+ ),
+ "process.env.OpenAIToken": JSON.stringify(process.env.OpenAIToken || ""),
+ "process.env.NODE_DEBUG": JSON.stringify(false),
+ },
+ resolve: {
+ dedupe: ["styled-components"],
+ alias: {
+ "@": resolve(__dirname, "./src"),
+ },
+ },
+ optimizeDeps: {
+ exclude: ["parquet-wasm", "@loaders.gl/parquet", "apache-arrow"],
+ include: [
+ "buffer",
+ "react",
+ "react-dom",
+ "react-redux",
+ "redux",
+ "styled-components",
+ "@kepler.gl/components",
+ "@kepler.gl/reducers",
+ "@kepler.gl/actions",
+ "@kepler.gl/constants",
+ "@kepler.gl/utils",
+ "@kepler.gl/schemas",
+ "@kepler.gl/table",
+ "@kepler.gl/layers",
+ "@kepler.gl/deckgl-layers",
+ "@kepler.gl/effects",
+ "@kepler.gl/styles",
+ "@kepler.gl/tasks",
+ "@deck.gl/core",
+ "@deck.gl/layers",
+ "@deck.gl/aggregation-layers",
+ "@deck.gl/geo-layers",
+ "@deck.gl/mesh-layers",
+ "@deck.gl/extensions",
+ "@luma.gl/core",
+ "@luma.gl/engine",
+ "@luma.gl/gltools",
+ "@luma.gl/shadertools",
+ "@luma.gl/webgl",
+ "@loaders.gl/core",
+ "@loaders.gl/gltf",
+ "@loaders.gl/images",
+ "@loaders.gl/parquet",
+ "@math.gl/core",
+ "@math.gl/web-mercator",
+ "gl-matrix",
+ "lodash.uniq",
+ ],
+ esbuildOptions: {
+ target: "es2020",
+ },
+ },
+});