Merge pull request #4 from metabase/readme-update

readme updates

Author: albertoperdomo

README.md

@@ -1,28 +1,107 @@
-# Metabase Node.js Interactive Embedding Sample
+# Metabase Node.js interactive embedding sample
 
-This is the sample code for the Metabase Node.js Interactive Embedding Quickstart.
+Sample code for the Metabase Node.js Interactive Embedding Quickstart LINK.
 
-Please check out the code for an example of how to integrate interactive embedding into your Node.js applications.
+You'll need a paid version of Metabase up and running. If you're not sure where to start, sign up for Metabase Cloud: Pro. LINK.
 
-## What is Metabase?
+## Set up your Metabase
 
-## Running the sample code
-1. Make sure you have updated enabled JWT for SSO under admin settings, and you have entered your app's SSO endpoint as the JWT Identity Provider URI. The path is `/sso/metabase`, e.g. `http://localhost:8080/sso/`metabase
-2. Make sure you define the following env vars defined:
-** `export METABASE_SITE_URL="https://myapp.metabaseapp.com"` - the root path of your Metabase instance,
-** `export METABASE_JWT_SHARED_SECRET="COPY_SECRET_FROM_JWT_CONFIG"` - you grab this from the SSO JWT config in admin settings
-3. Create a dashboard using X-ray on the invoices table in the sample dataset. If the ID is not 1, then update `METABASE_DASHBOARD_PATH` in `index.js`.  
-3. Start the sample with `node index.js`. It runs by default on port 8080.
-4. Hit http://localhost:8080, sign in and hit `/analytics` with both users to populate them to Metabase.
-5. Create groups `Customer Acme` and `Customer Fake` and configure permissions so they can access the collection in which the dashboard is located. Also, setup data sandboxing on the Invoices table filtering on `accountId`.
-6. Under SSO then activate group membership syncing and map `Customer-Acme` and `Customer-Fake` to the groups you've created.
-7. You should be able to sign in with the two users and see the dashboard. If not, check the collection permissions for their respective groups.
-8. Both users should be able to see the same dashboard but with different data, beacuse of sandboxing.
+### Create a dashboard
 
-## Create a free Metabase trial
+In the left nav, go to **Browse data** > **Sample Database**. Hover over the `Invoices` table and click on the lightning bolt to X-ray the table.
 
-* For interactive embedding, you will need a Pro or Enterprise plan.
-* You can sign up for a free trial at https://store.metabase.com/checkout
+Click the button to **Save this** as a dashboard. Metabase will save this dashboard in the collection called "Automatically generated dashboards".
+
+Visit that dashboard in the "Automatically generated dashboards" and make a note of its URL. If it's the first dashboard you created, it's probably `/dashboard/1` followed by a description.
+
+### Enable SSO with JWT
+
+From any Metabase page, click on the **gear** icon in the upper right and select **Admin Settings** > **Settings** > **Authentication**.
+
+On the card that says **JWT**, click the **Setup** button.
+
+### JWT Identity provider URI
+
+In **JWT IDENTITY PROVIDER URI** field, paste  `localhost:8080/login`.
+
+### String used by the JWT signing key
+
+Click the **Generate key** button. Copy the key.
+
+## Running the server
+
+### Install packages
+
+Run:
+
+```sh
+npm install
+```
+
+### Set environment variables
+
+You'll need to set some environment variables for your server.
+
+- [METABASE_SITE_URL](#metabase_site_url)
+- [METABASE_JWT_SHARED_SECRET](#metabase_jwt_shared_secret)
+- [METABASE_DASHBOARD_PATH](#)
+
+### METBASE_SITE_URL
+
+```sh
+export METABASE_SITE_URL="https://myapp.metabaseapp.com"
+```
+
+Replacing "https://myapp.metabaseapp.com" with the root path of your Metabase.
+
+### METABASE_JWT_SHARED_SECRET
+
+```sh
+export METABASE_JWT_SHARED_SECRET="COPY_SECRET_FROM_JWT_CONFIG"
+```
+You can get this key from your Metabase by clicking on the **gear** icon and going to **Admin Settings** > **Settings** > **Authentication** > **JWT**.
+
+### METABASE_DASHBOARD_PATH
+
+If the dashboard you created above doesn't have an ID of 1, you'll also need to update the path:
+
+```sh
+export METABASE_DASHBOARD_PATH=`/dashboard/id`
+```
+
+Replacing `id` with the ID number of your dashboard.
+
+## Starting the app
+
+Start the server by running:
+
+```sh
+node index.js
+```
+
+The app runs by default on port 8080.
+
+Visit [http://localhost:8080/analytics](localhost:8080/analytics) and sign in with the following credentials:
+
+```sh
+user: [email protected]
+password: foobar
+```
+
+## Set up groups
+
+TODO
+
+Create groups `Customer Acme` and `Customer Fake` and configure permissions so they can access the collection in which the dashboard is located. Also, setup data sandboxing on the Invoices table filtering on `accountId`.
+
+Under SSO then activate group membership syncing and map `Customer-Acme` and `Customer-Fake` to the groups you've created.
+8. You should be able to sign in with the two users and see the dashboard. If not, check the collection permissions for their respective groups.
+
+## Set up sandboxing
+
+TODO
+
+Both users should be able to see the same dashboard but with different data, beacuse of sandboxing.
 
 ## Reporting issues
 
@@ -34,4 +113,4 @@ Please report bugs or feature requests as issues in this reporsitory. Please do
 
 ## License
 
-This project is licensed under the MIT license. See the [LICENSE](./LICENSE) file for more info.
+This project is licensed under the MIT license. See the [LICENSE](./LICENSE) file for more info.