Quick Start

In this Quick Start we will be getting a dice roller Fluid application up and running on your computer’s localhost. We’ve already embedded an instance of the application, with two clients, below. Click the Roll button in either client to see how the state of the dice is shared between the two clients.

Set up your development environment

To get started you need the following installed.

We also recommend that you install the following:

Getting Started

Open a new command window and navigate to the folder you where you want to install the project, and then clone the FluidHelloWorld repo with the following commands. The cloning process will create a subfolder named FluidHelloWorld with the project files in it.

git clone https://github.com/microsoft/FluidHelloWorld.git


If you don’t have git installed you can click here to download a zip of the FluidHelloWorld repo. Once the file downloads, extract the contents of the .zip file and run the following steps.

Navigate to the newly created folder and install required dependencies.

cd FluidHelloWorld
npm install

Start both the client and server.

npm start

A new browser tab will open to http://localhost:8080 and you will see the dice roller appear! To see collaboration in action copy the full URL in the browser, including the ID, into a new window or even a different browser. This opens a second client for your dice roller application. With both windows open, click the Roll button in either and note that the state of the dice changes in both clients.

🥳Congratulations🎉 You have successfully taken the first step towards unlocking the world of Fluid collaboration.

Next Steps

Start learning how to work with the Fluid Framework APIs with our tutorial.

Or, if you would like to start a new Fluid project from scratch, the available packages are labeled in the Fluid API Section of the documentation.

To install your packages you can follow this format: npm i package-name if you use npm or yarn add package-name if you use yarn.

We use the following Fluid packages in this quickstart:

  • @fluidframework/aqueduct
  • @fluid-experimental/get-container
  • @fluidframework/map
  • tinylicious
    • Note: Tinylicious is only a development dependency, since it is the service used when developing your Fluid app. You can install it as a development dependency using npm i tinylicious --save-dev or yarn add tinylicious --dev.