Skip to content

Update docs to recommend installing from npm #8

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

Merged
tirodkar merged 1 commit into from
May 19, 2026
Merged

Update docs to recommend installing from npm #8

Show file tree
Hide file tree
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
17 changes: 2 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,26 +109,13 @@ The backend server is powered by Python and runs our sample agent.

The frontend is a React web application that communicates with the backend agent and renders the interactive UI.

1. **Build and link the core @googlemaps/a2ui library:**
First, we need to compile the core web components in the `a2ui` repository and make them available locally via `npm link`. From your main parent folder, navigate to the core client directory:
```bash
cd a2ui/client/web
npm run build-and-link
```

2. **Navigate to the sample React client directory:**
```bash
cd ../../../a2ui-samples/client/web/react
```

3. **Install dependencies, link the core library, and start the development server:**
1. **Install dependencies and start the development server:**
```bash
npm install
npm link @googlemaps/a2ui
npm run dev
```

4. **See the demo working live!** 🌟
2. **See the demo working live!** 🌟
Open [http://localhost:5173](http://localhost:5173) in your web browser to interact with your fully functioning Agentic UI demo!

## Google API Keys
Expand Down
12 changes: 2 additions & 10 deletions client/web/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,13 @@ Note: this example requires a valid Google Maps API Key to be set within [index.

## To run this sample project

1. Download the latest Agentic UI Toolkit source files.
2. Open the a2ui/client/web directory in a terminal and run:

```
npm run build-and-link
```

3. Open this directory in a terminal, and run:
1. Open this directory in a terminal, and run:

```
npm install
npm link @googlemaps/a2ui
npm run dev
```

4. Open [http://localhost:5173](http://localhost:5173) in your browser. You should see a chat interface.
2. Open [http://localhost:5173](http://localhost:5173) in your browser. You should see a chat interface.

To run the backend, follow the instructions in [../../../agent/python/README.md](../../../agent/python/README.md)
64 changes: 64 additions & 0 deletions client/web/react/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions client/web/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
"type": "module",
"scripts": {
"dev": "vite",
"build": "npm run build:@googlemaps/a2ui && tsc -b && vite build",
"build": "tsc -b && vite build",
"lint": "eslint .",
"preview": "vite preview",
"build:@googlemaps/a2ui": "cd ../../../../a2ui/client/web && npm install && npm run build && npm link && cd ../../../a2ui-samples/client/web/react && npm link @googlemaps/a2ui"
"preview": "vite preview"
},
"dependencies": {
"@a2a-js/sdk": "^0.3.13",
"@a2ui/lit": "^0.9.1",
"@a2ui/markdown-it": "^0.0.1",
"@googlemaps/a2ui": "^0.1.0",
"react": "^19.2.4",
"react-dom": "^19.2.4"
},
Expand All @@ -31,4 +31,4 @@
"typescript-eslint": "^8.57.0",
"vite": "^8.0.1"
}
}
}
Loading