diff --git a/README.md b/README.md index 89b4439..21cca8f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ ## Step 1) A custom localhost domain ---- in your /etc/hosts add an entry for embed.demo.com -127.0.0.1 embed.demo.com -
+ +```127.0.0.1 embed.demo.com``` + +
## Step 2) configure green ssl ---- create an ssl cert pair named cert.pem and cert.key and place them under the /ssl folder I found this process worked for me on mac, with the latest browser updates. [Link to Tutorial](https://eengstrom.github.io/musings/self-signed-tls-certs-v.-chrome-on-macos-catalina) @@ -17,27 +17,23 @@ Green SSL is required for events ## Step 3) configure looker ---- ensure https://embed.demo.com:3000 is added to your looker's embed domain whitelist -at <>.cloud.looker.com/admin/embed +at `<>.cloud.looker.com/admin/embed`

## Step 4) fill out config.ini ---- -I left a config.ini.example with values in it to make it as clear as possible (avoiding little issues like trailing slashes) +I left a `config.ini.example` with values in it to make it as clear as possible (avoiding little issues like trailing slashes) rename it to config.ini and put in your real values

-## Step 5) put in the correct host at ---- -frontend/src/components/dashboard.js line 14. this app does not put in the config.ini values onto the frontend +## Step 5) put in the correct host at +`frontend/src/components/dashboard.js` line 14. this app does not put in the config.ini values onto the frontend

## Step 6) install the dependencies ---- (highly reccomended to use a virtual environment) ``` pip install -r requirements.txt @@ -45,10 +41,8 @@ cd frontend npm install ```
-
## Step 7) Run it! ---- I didn't link them up into a single command, so you might need to open two shells ``` python main.py @@ -59,11 +53,9 @@ npm start Now you should be redirected to https://embed.demo.com:3000 where you should see an embeded dashboard with an event that triggered a simple 'Successfully Loaded!' message -

## Step 8) Vary the user and URL generation methods ---- User: Since in your real application, the URL will need to be sensitive to the logged in user this demonstrates how the frontend's request will change what the user sees via the userToken