Get started - Get started with Liveblocks and Zustand
Liveblocks is a realtime collaboration infrastructure for building performant
collaborative experiences. Follow the following steps to start making your
Zustand store multiplayer by using the middleware from the
@liveblocks/zustand
package.
Quickstart
Install Liveblocks
Every Liveblocks package should use the same version.
Initialize the
liveblocks.config.ts
fileWe can use this file later to define types for our application.
Connect your Zustand store to Liveblocks
Create the Liveblocks client and use the
middleware
in your Zustand store setup. This will add a new state calledliveblocks
to your store, enabling you to interact with our Presence and Storage APIs.store.tsJoin a Liveblocks room
Liveblocks uses the concept of rooms, separate virtual spaces where people collaborate. To create a realtime experience, multiple users must be connected to the same room.
App.tsxUse the Liveblocks data from the store
Now that we’re connected to a room, we can start using the Liveblocks data from the Zustand store.
Room.tsxNext: set up authentication
By default, Liveblocks is configured to work without an authentication endpoint where everyone automatically has access to rooms. This approach is great for prototyping and marketing pages where setting up your own security isn’t always required. If you want to limit access to a room for certain users, you’ll need to set up an authentication endpoint to enable permissions.
Set up authentication
What to read next
Congratulations! You now have set up the foundation to start building collaborative experiences for your Zustand store.
- @liveblocks/zustand API Reference
- Zustand guides
- How to use Liveblocks Presence with Zustand
- How to use Liveblocks Storage with Zustand