Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Misc] Update demo-app README.md #2934

Merged
merged 1 commit into from
Jan 23, 2025
Merged

[Misc] Update demo-app README.md #2934

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions examples/demo-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,41 @@ This is the src code of kepler.gl demo app. You can copy this folder out and run

#### 1. Install Dependencies

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

```sh
yarn install
yarn bootstrap
```

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

#### 2. Mapbox Token and Cloud storage client id
A collection of environment variables to pass mapbox tokens, and client ids for the cloud storages
```sh
yarn install
```

#### 2. Environment Variables
Create a `.env` file at the root directory by copying from `.env.template`:

```sh
export MapboxAccessToken=<your_mapbox_token>
export DropboxClientId=<your_dropbox_client_id>
export MapboxExportToken=<your_mapbox_export_token>
export CartoClientId=<your_carto_client_id>
export FoursquareClientId=<your_foursquare_client_id>
export FoursquareDomain=<your_foursquare_domain>
export FoursquareUserMapsURL=<your_foursquare_user_map_url>
cp .env.template .env
```

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

```sh
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

```sh
yarn start
yarn start:local
```

[yarn-install]: https://yarnpkg.com/getting-started/install
Loading