Merge pull request #2 from demartsc/sidepanel-style

Add custom side panel wrapper to scale it down, fix scrolling

Author: Chris DeMartini

.gitignore

@@ -20,3 +20,4 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 yarn.lock
+package-lock.json

README.md

@@ -1,17 +1,52 @@
+# Kepler.gl Tableau
+
+## Introduction
+This is the kepler.gl tableau extension. It will load a kepler.gl map visualization inside your Tableau Desktop App.
+
+## Links
+- [kepler.gl](http://kepler.gl)
+- [Tableau Extensions API](https://tableau.github.io/extensions-api/#)
+
 This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
 
-To run this project...
-- Clone repo
-- yarn
-- yarn run start
-- don't forget the trex file and tableau workbook (in the public folder)
-
-To execute extension in tableau
-- follow above steps to run extension locally on your machine. 
-- open tableau workbook (get it from public folder of this repo)
-    - NOTE: if you want to enable remote debugging, use this command in terminal to open tableau 
-        *open /Applications/Tableau\ Desktop\ 2018\.2.app --args --remote-debugging-port=8696*
-
-- copy the trex file (get it from public folder) into your "extensions" folder of the my tableau repository (likely in your documents folder). 
-- Go to the Tableau window that opened when running the above command. 
-- Drag the extension onto view and select the trex file from your my tableau repository\extensions folder. 
+## Local Development
+
+### Start node app
+##### 1. Clone repo
+```sh
+git clone <>
+```
+
+##### 2. Install
+```sh
+yarn --ignore-engines
+```
+
+##### 3. Start local app session
+```sh
+yarn run start
+```
+
+### Setup local extension in Tableau Desktop
+##### 1. Launch Tableau
+open tableau workbook (get it from public folder of this repo)
+- NOTE: if you want to enable remote debugging, use this command in terminal to open tableau
+
+```sh
+open /Applications/Tableau\ Desktop\ 2018\.3.app --args --remote-debugging-port=8696
+```
+
+A debug session will be available in browser http://localhost:8696
+
+##### 2. Execute extension in tableau
+
+- copy the `datablick-kepler-gl.trex` file (inside the `public` folder) into your `extensions` folder of the `My Tableau Repository` (likely in your `Documents` folder).
+
+- Go to the Tableau window that opened when running the above command.
+
+- Drag the extension onto view and select the trex file from your my tableau repository\extensions folder.
+
+- More information on Tableau Extension API about [Get Started with Dashboard Extensions
+](https://tableau.github.io/extensions-api/docs/trex_getstarted.html)
+
+