Skip to content

[WEB-4321] Local examples TLC #3005

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
GregHolmes merged 2 commits into from
Dec 5, 2025
Merged

[WEB-4321] Local examples TLC #3005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2b122b
fix: add missing dependency for franken-ui
kennethkalmer Dec 4, 2025
f4ba229
fix: remove leading slash from `cd examples` in the example readme's
kennethkalmer Dec 4, 2025
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
4 changes: 2 additions & 2 deletions examples/auth-generate-jwt/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Find out more about [authentication](https://ably.com/docs/auth/token?lang=javas
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Install dependencies:
Expand All @@ -45,7 +45,7 @@ Find out more about [authentication](https://ably.com/docs/auth/token?lang=javas
5. In a new tab, change directory:

```sh
cd /examples/
cd examples/
```

6. Rename the environment file:
Expand Down
4 changes: 2 additions & 2 deletions examples/auth-generate-jwt/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Find out more about [authentication](https://ably.com/docs/auth/token?lang=javas
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Install dependencies:
Expand All @@ -45,7 +45,7 @@ Find out more about [authentication](https://ably.com/docs/auth/token?lang=javas
5. In a new tab, change directory:

```sh
cd /examples/
cd examples/
```

6. Rename the environment file:
Expand Down
4 changes: 2 additions & 2 deletions examples/auth-request-token/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Find out more about [authentication](/docs/auth).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Install dependencies:
Expand All @@ -45,7 +45,7 @@ Find out more about [authentication](/docs/auth).
5. In a new tab, change directory:

```sh
cd /examples/
cd examples/
```

6. Rename the environment file:
Expand Down
4 changes: 2 additions & 2 deletions examples/auth-request-token/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Find out more about [authentication](/docs/auth).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Install dependencies:
Expand All @@ -45,7 +45,7 @@ Find out more about [authentication](/docs/auth).
5. In a new tab, change directory:

```sh
cd /examples/
cd examples/
```

6. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-presence/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Find out more about [presence](/docs/chat/rooms/presence?lang=javascript).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-presence/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Find out more about [presence](/docs/chat/rooms/presence?lang=react).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-room-history/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Find out more about [message history](/docs/chat/rooms/history?lang=javascript).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-room-history/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Find out more about [message history](/docs/chat/rooms/history?lang=react).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-room-messages/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Find out more about [rooms](/docs/chat/rooms?lang=javascript) and [messages](/do
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-room-messages/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [rooms](/docs/chat/rooms?lang=react) and [messages](/docs/ch
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-room-reactions/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Find out more about [room reactions](/docs/chat/rooms/reactions?lang=javascript)
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-room-reactions/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [room reactions](/docs/chat/rooms/reactions).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-typing-indicator/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [typing indicators](/docs/chat/rooms/typing).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-typing-indicator/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [typing indicators](/docs/chat/rooms/typing).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-ui-app/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This example uses the `App` component from the Ably Chat UI React Kit, and is wr
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-ui-chat-window/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This example uses the `ChatWindow` component from the Ably Chat UI React Kit, an
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/chat-ui-sidebar/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This example uses the `Sidebar` component from the Ably Chat UI React Kit, and i
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/liveobjects-live-counter/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Find out more about [LiveCounter](/docs/liveobjects/counter).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/liveobjects-live-map/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Find out more about [LiveMap](/docs/liveobjects/map).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
3 changes: 3 additions & 0 deletions examples/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@
"ably": "^2.14.0",
"cors": "^2.8.5",
"franken-ui": "^2.0.0",
"lodash": "^4.17.21",
"minifaker": "^1.34.1",
"nanoid": "^5.0.7",
"react": "^18",
Expand All @@ -131,7 +132,9 @@
"express": "^4.21.1",
"postcss": "^8.5.3",
"postcss-combine-duplicated-selectors": "^10.0.3",
"postcss-js": "^4.0.1",
"postcss-load-config": "^6.0.1",
"postcss-sort-media-queries": "^5.2.0",
"tailwindcss": "3",
"typescript": "^5",
"vite": "4"
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-channel-messages/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Find out more about [channels](/docs/channels) and [messages](/docs/channels/mes
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-channel-messages/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [channels](/docs/channels) and [messages](/docs/channels/mes
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-channel-state/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Find out more about [channel states](/docs/channels/states).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-channel-state/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Find out more about [channel states](/docs/channels/states).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-connection-state/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Find out more about [connection states](/docs/connect/states).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-connection-state/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Find out more about [connection states](/docs/connect/states).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-history/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Find out more about [history](/docs/storage-history/history).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-history/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [history](/docs/storage-history/history).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-message-annotations/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This example demonstrates:
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-message-encryption/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Find out more about [channels](/docs/channels), [messages](/docs/channels/messag
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-message-encryption/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [channels](/docs/channels), [messages](/docs/channels/messag
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-occupancy/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Find out more about [occupancy](/docs/presence-occupancy/occupancy).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-occupancy/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Find out more about [occupancy](/docs/presence-occupancy/occupancy).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-presence/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [presence](/docs/presence-occupancy/presence).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-presence/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [presence](/docs/presence-occupancy/presence).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-rewind/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Find out more about [rewind](https://ably.com/docs/channels/options/rewind).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/pub-sub-rewind/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Find out more about [rewind](https://ably.com/docs/channels/options/rewind).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/spaces-avatar-stack/javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [avatar stack](/docs/spaces/avatar).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
2 changes: 1 addition & 1 deletion examples/spaces-avatar-stack/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find out more about [avatar stack](/docs/spaces/avatar).
2. Change directory:

```sh
cd /examples/
cd examples/
```

3. Rename the environment file:
Expand Down
Loading