Skip to content

Commit

Permalink
done
Browse files Browse the repository at this point in the history
  • Loading branch information
pballai committed Jul 23, 2024
1 parent 4e17937 commit e33a194
Showing 1 changed file with 16 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ We have broken the different types of embeds into separate documents based on us

Additionally, it will demonstrate how to set up a local web application so that you can simulate using Sigma Embedding on your local computer. The local web application (Parent application) is to be reused on a few of the other embedding QuickStarts as required.

For those interested, there is a comprehensive whitepaper, [Embedded Analytics Solutions for Secure Embedding](https://www.sigmacomputing.com/white-papers/white-paper-embedded-analytics)
For those interested, there is a comprehensive ebook, [The Ultimate Guide To Embedded Analytics](https://www.sigmacomputing.com/white-papers/white-paper-embedded-analytics)

### Target Audience
Semi-technical users who will be aiding in the planning or implementation of Sigma with embedding. No SQL or technical data skills are needed to do this QuickStart. It does assume some common computer skills like installing software, using Terminal, navigating folders and copy/paste operations.
Expand Down Expand Up @@ -259,18 +259,27 @@ npm install express
<img src="assets/applicationsetup5.png" width="700"/>

### Node Supervisor
Node-supervisor is a package that runs our program, and watches for plaintext changes, so we can have hot-reloading-ish behavior.
This package is the "manager" that we referred to earlier and is not really required, but can be a time-saver, so we prefer to include it.

This means that we don't need to worry about restarting your application (in this case, Node) each time we make a change to the server.js file.
Node-supervisor is a node package that monitors our parent application, and watches for plaintext changes to the code. As we make configuration changes and save them, supervisor "sees" this and forces a reload. This means that we don't need to worry about restarting your application (in this case, Node) each time we make a change to the server.js file.

**A browser refresh will still be required to see the changes on the webpage. **
While the supervisor package is not technically required, it is a real time-saver when making quick code changes during the QuickStart embed series.

You can complete this QuickStart without supervisor. If you elect to do that, all that is required is that you restart node after each change to the project files code.

To do that, all that is required is to stop node in the terminal session where it is running (CTRL+C), and then restart node again.

To run our project without supervisor, a terminal session is opened and the command that is run is:
```code
node embed-api.js
```

**A browser refresh will still be required to see the changes on the final application webpage. **

<aside class="negative">
<strong>NOTE:</strong><br> There is an extension for Chrome called "LiveReload" which will also handle the browser refresh for you. We leave that up to the user to decide if they want to install and enable any browser extension.
<strong>NOTE:</strong><br> There is an extension for Chrome / Firefox called "LiveReload" which will also handle the browser refresh for you. We leave that up to the user to decide if they want to install and enable any browser extension.
</aside>

While the supervisor package is not technically required, it is a real time-saver when making quick code changes during the QuickStart embed series.

**Run the command:**
```code
npm install supervisor
Expand Down

0 comments on commit e33a194

Please sign in to comment.