Skip to content

Add troubleshooting section to README for common dependency issues #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add troubleshooting section to README for common dependency issues #131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,33 @@ Original demos:
- [demos/GenWeather](https://github.com/google-gemini/multimodal-live-api-web-console/tree/demos/genweather)
- [demos/GenList](https://github.com/google-gemini/multimodal-live-api-web-console/tree/demos/genlist)

## Troubleshooting

If you encounter dependency issues during installation, ensure you're using the latest version from the `main` branch. Common issues include:

### `react-scripts` not found

If you see an error like `'react-scripts' is not recognized as an internal or external command`, verify that `react-scripts` is set to version `5.0.1` or higher in `package.json`:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The package.json file pins react-scripts to version 5.0.1. The phrase "or higher" could be confusing, as it suggests a version range is acceptable, while the code example and the project's package.json use a specific, pinned version. For clarity and to align with the project's configuration, it's better to recommend the exact version.

Suggested change
If you see an error like `'react-scripts' is not recognized as an internal or external command`, verify that `react-scripts` is set to version `5.0.1` or higher in `package.json`:
If you see an error like `'react-scripts' is not recognized as an internal or external command`, verify that `react-scripts` is set to version `5.0.1` in `package.json`:


```json
"react-scripts": "5.0.1"
```

### `react-syntax-highlighter` module errors

If you encounter errors like `Module not found: Error: Can't resolve 'react-syntax-highlighter/dist/esm/styles/hljs'`, ensure the package version is `15.5.0` or higher:

```json
"react-syntax-highlighter": "^15.6.1"
```

After verifying your `package.json`, run:

```bash
npm install
npm start
```

## Example

Below is an example of an entire application that will use Google Search grounding and then render graphs using [vega-embed](https://github.com/vega/vega-embed):
Expand Down