README.md

Overview

This folder contains the code for the Avatar Stack - a demo of how you can leverage Ably to show a list of currently online users.

Try out the live demo of the avatar stack.

Running locally

• Fork or clone the Examples Repo.
• Sign up for an account on Ably and get an API KEY.
• Rename .env.example to .env and fill in your API KEY in the VITE_ABLY_KEY environment variable.
  • You could also use the VITE_ABLY_KEY_AVATAR_STACK environment variable if you wanted to use different keys for different examples.
• Run yarn or npm install to install dependencies.
• Run yarn dev or npm run dev and go to http://localhost:5173/avatar-stack

Runtime Requirements

• Node.js
• Ably API Key
• Yarn (optional)

Resources

• Learn more about how to build your own avatar stack.
• To see what else is possible with Ably check out our other realtime examples.

Requirements (if any)

Support, feedback and troubleshooting

• Create a GitHub Issue
• Join our Discord server
• Follow us on Twitter
• Use our SDKs
• Visit our website

---