Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Russ Garner committed Jun 28, 2022
1 parent f9af234 commit 5d7980b
Showing 1 changed file with 38 additions and 10 deletions.
48 changes: 38 additions & 10 deletions README
Original file line number Diff line number Diff line change
@@ -1,41 +1,69 @@

Step 1) Sorry I like to have a custom localhost domain!
## Step 1) A custom localhost domain
---
in your /etc/hosts add an entry for embed.demo.com
127.0.0.1 embed.demo.com
<br/>
<br/>

Step 2) configure green ssl
## 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. Green SSL is required for events
https://eengstrom.github.io/musings/self-signed-tls-certs-v.-chrome-on-macos-catalina
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)
Green SSL is required for events
<br/>
<br/>


Step 3) configure looker
## Step 3) configure looker
---
ensure https://embed.demo.com:3000 is added to your looker's embed domain whitelist
at <<yourlooker>>.cloud.looker.com/admin/embed
<br/>
<br/>

Step 4) fill out config.ini
## 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)
rename it to config.ini and put in your real values
<br/>
<br/>

Step 5) put in the correct host at
## 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
<br/>
<br/>

Step 5) install the dependencies
## Step 6) install the dependencies
---
(highly reccomended to use a virtual environment)
```
pip install -r requirements.txt
cd frontend
npm install
```
<br/>
<br/>

Step 6) Run it!
## 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
cd frontend
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 7) Vary the user and URL generation methods as a test
<br/>
<br/>

## 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
Expand Down

0 comments on commit 5d7980b

Please sign in to comment.