Get started - Get started with Liveblocks and Vue.js

Liveblocks is a real-time collaboration infrastructure for building performant collaborative experiences. Follow the following steps to start adding collaboration to your Vue.js application using the APIs from the @liveblocks/client package.

Quickstart

1. Install Liveblocks

   $npm install @liveblocks/client

2. Set up the client

   The first step in connecting to Liveblocks is creating a client which will be responsible for communicating with the back end.

   const client = createClient({  publicApiKey: "pk_prod_xxxxxxxxxxxxxxxxxxxxxxxx",});

3. Join a Liveblocks room

   Liveblocks uses the concept of rooms, separate virtual spaces where people collaborate. To create a real-time experience, multiple users must be connected to the same room.

   const room = client.enter("my-room", { initialPresence: {} });

4. Use the Liveblocks methods

   Now that we’re connected to a room, we can start using Liveblocks subscriptions. The first we’ll add is others, a subscription that provides information about which other users are connected to the room.

   <script setup>import { onUnmounted, ref } from "vue";import { room } from "./room.js";
   const others = ref(room.getOthers());
   const unsubscribeOthers = room.subscribe("others", (updatedOthers) => {  others.current = updatedOthers;});
   onUnmounted(() => {  unsubscribeOthers();});</script>
   <template>  <div>There are {{ others.length }} other user(s) online</div></template>

5. Bonus: set up authentication

   By default, Liveblocks is configured to work without an authentication endpoint. This approach is great for prototyping and marketing pages where defining your own security isn’t always required. If you want to implement your own security logic to define if certain users should have access to a given room, you’ll need to implement an authentication endpoint.

   Set up authentication

Next steps

Congratulations! You now have set up the foundation to start building collaborative experiences for your Vue.js application.

• API Reference