Skip to content

Commit 9a72cbf

Browse files
committed
update README.md and package.json
1 parent 8801ea3 commit 9a72cbf

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,15 @@ This is the kepler.gl tableau extension. It will load a kepler.gl map visualizat
1010
This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
1111

1212
## Local Development
13+
Install [node](https://nodejs.org/en/download/package-manager/) (`> 6`), [yarn](https://yarnpkg.com/en/docs/install).
1314

14-
### Start node app
15+
Use Node v6 and above, older node versions have not been tested.
16+
For best management of Node versions, use [nvm](https://github.com/creationix/nvm) `nvm install`.
17+
18+
### Start Node app
1519
##### 1. Clone repo
1620
```sh
17-
git clone <>
21+
git clone [email protected]:uber/kepler.gl-tableau.git
1822
```
1923

2024
##### 2. Install
@@ -25,6 +29,8 @@ yarn --ignore-engines
2529
##### 3. Start local app session
2630
```sh
2731
yarn start
32+
# or
33+
npm start
2834
```
2935

3036
### Setup local extension in Tableau Desktop
@@ -49,4 +55,8 @@ A debug session will be available in browser http://localhost:8696
4955
- More information on Tableau Extension API about [Get Started with Dashboard Extensions
5056
](https://tableau.github.io/extensions-api/docs/trex_getstarted.html)
5157

52-
58+
### Deploy
59+
Deploy local app to uber.github.io, this will be the app that Tableau extension loads from
60+
```sh
61+
npm run deploy
62+
```

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "tableau-kepler-gl",
2+
"name": "kepler.gl-tableau",
33
"version": "0.1.0",
4-
"homepage": "https://demartsc.github.io/tableau-kepler-gl",
4+
"homepage": "https://uber.github.io/kepler.gl-tableau",
55
"private": true,
66
"dependencies": {
77
"@atlaskit/css-reset": "^3.0.2",

0 commit comments

Comments
 (0)