Skip to content

Commit

Permalink
Update README.md (#94)
Browse files Browse the repository at this point in the history
docs: added information on specific node version installation requirements (>17) and removed section for cloning the looker-explore-assistant repo since I moved it to the 'Getting Started' section of the repo landing page.

Co-authored-by: Luka Fontanilla <[email protected]>
  • Loading branch information
kalib-brayer and LukaFontanilla authored Sep 18, 2024
1 parent 27414a8 commit 9bda21f
Showing 1 changed file with 11 additions and 22 deletions.
33 changes: 11 additions & 22 deletions explore-assistant-extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,9 @@ This section describes how to set up the LLM Integration for the Explore Assista

### Getting Started for Development

1. Clone or download a copy of this repository to your development machine.
If you have a git ssh_config:
```bash
# cd ~/ Optional. your user directory is usually a good place to git clone to.
git clone [email protected]:looker-open-source/looker-explore-assistant.git
```

If not:
```bash
# cd ~/ Optional. your user directory is usually a good place to git clone to.
git clone https://github.com/looker-open-source/looker-explore-assistant.git
```
Alternatively, open up this repository in: &nbsp;
[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/looker-open-source/looker-explore-assistant.git&cloudshell_workspace=explore-assistant-extension)
1. Install a backend using terraform by [following the instructions](../explore-assistant-backend/README.md)

2. Install a backend using terraform by [following the instructions](../explore-assistant-backend/README.md)

3. Save the backend details for use by the extension framework:
2. Save the backend details for use by the extension framework:

* The BigQuery example dataset and table name
* If you're using the BigQuery backend, the model id that allows communication with Gemini
Expand Down Expand Up @@ -58,17 +43,21 @@ jsonPayload.component="explore-assistant-metadata"
cd explore-assistant-extension
```

1. Install the dependencies with [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). *Please follow the hyperlinked directions for installing node and npm on your machine. Skip this step if deploying from Cloud Shell method above.* Additionally if you need to work across multiple Node versions, `nvm` can be used switch between and install different node versions.
2. Install the dependencies with [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). *Please follow the hyperlinked directions for installing node and npm on your machine. Skip this step if deploying from Cloud Shell method above.* Additionally if you need to work across multiple Node versions, `nvm` can be used switch between and install different node versions. When installing node, you need to install a version less than 17.

```bash
npm install
```

> You may need to update your Node version or use a [Node version manager](https://github.com/nvm-sh/nvm) to change your Node version.
> You may need to update your Node version or use a [Node version manager](https://github.com/nvm-sh/nvm) to change your Node version. You can print your version number in terminal with the following command:
```bash
$ node -v
```

2. Create a new BigQuery connection in Looker that will allow us to get the examples from the database. You will use that in the VERTEX_BIGQUERY_LOOKER_CONNECTION_NAME below.
3. Create a new BigQuery connection in Looker that will allow us to get the examples from the database. You will use that in the VERTEX_BIGQUERY_LOOKER_CONNECTION_NAME below.

3. Ensure all the appropriate environment variables are set in the `.env` file
4. Ensure all the appropriate environment variables are set in the `.env_example` file. Also rename the `.env_example` file to `.env`.

Regardless of the backend, you're going to need:

Expand Down Expand Up @@ -169,4 +158,4 @@ The process above requires your local development server to be running to load t

Note that the additional JavaScript files generated during the production build process do not have to be mentioned in the manifest. These files will be loaded dynamically by the extension as and when they are needed. Note that to utilize code splitting, the Looker server must be at version 7.21 or above.

---
---

0 comments on commit 9bda21f

Please sign in to comment.