Skip to content

Improve getting started project setup instructions #2605

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
merged 1 commit into from
May 15, 2025
Merged

Improve getting started project setup instructions #2605

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: 10 additions & 7 deletions content/chat/getting-started/javascript.textile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,23 @@ ably apps switch
ably auth keys switch
```

* Install "Node.js":https://nodejs.org/en version 18 or greater.
* Install "ts-node":https://www.npmjs.com/package/ts-node to execute TypeScript files:
* Install any current LTS version of "Node.js":https://nodejs.org/en and create a new project:

```[sh]
npm install ts-node
npm init -y
```

* Create a new project in your IDE and install the Ably Chat JavaScript SDK. This will also install the Ably Pub/Sub SDK as it is a dependency:
* Install "typescript":https://www.npmjs.com/package/typescript to compile TypeScript files.
* Install "ts-node":https://www.npmjs.com/package/ts-node to execute TypeScript files directly.

```[sh]
npm init -y
tsc --init
npm install @ably/chat typescript ts-node
```

npm install @ably/chat
* Create a default TypeScript configuration in your project

```[sh]
npx tsc --init
```

<aside data-type='note'>
Expand Down