Skip to content

Commit

Permalink
style(demo): local realtime links
Browse files Browse the repository at this point in the history
  • Loading branch information
guspan-tanadi authored and splindsay-92 committed Feb 3, 2025
1 parent 22e5e5d commit e73facf
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ npm install
npm run start
```

##   Installation
## Installation

> [!NOTE] This demo app uses both the `ably-chat-js` core SDK and associated React hooks.
> [!NOTE]
> This demo app uses both the `ably-chat-js` core SDK and associated React hooks.
> This is accessible via `@ably/chat`.
1. First of all, you need to build the main Chat SDK and associated React hooks from the root directory (`(cd .. && npm run build)`).
Expand All @@ -23,12 +24,12 @@ npm run start
1. Copy `.env.example` to `.env.` and set the `VITE_ABLY_CHAT_API_KEY` to your Ably API key.
2. If you're using a custom Ably domain, also set the `VITE_ABLY_HOST` to your custom domain.

For Ably: if running local realtime, see `src/main.tsx`.
For Ably: if running local realtime, see [`src/main.tsx`](./src/main.tsx).

## Running

Run `npm run start`, and it will automatically open your browser on port 8888.

Use `npm run start-silent` if you'd rather not have your browser open automatically.

`npm run start` (and the `start-silent` version) will run both the API component for generating tokens and the front-end side. If you'd like to only run the front-end site use `npm run dev`.
`npm run start` (and the `start-silent` version) will run both the API component for generating tokens and the front-end side. If you'd like to only run the front-end site use `npm run dev`.

0 comments on commit e73facf

Please sign in to comment.