Quickstart: Dice roller

In this quickstart, we'll walk through the process of creating a dice roller app that uses the Azure Fluid Relay service. The quickstart is broken into two parts. In part one, we'll create the app itself and run it against a local Fluid server. In part two, we'll reconfigure the app to run against the Azure Fluid Relay service instead of the local dev server.

The sample code used in this quickstart is available here.

Set up your development environment

To follow along with this quickstart, you'll need an Azure account and Azure Fluid Relay provisioned. If you don't have an account, you can try Azure for free.

You'll also need the following software installed on your computer.

Getting Started Locally

First, you'll need to download the sample app from GitHub. Open a new command window and navigate to the folder where you'd like to download the code and use Git to clone the FluidHelloWorld repo. The cloning process will create a subfolder named FluidHelloWorld with the project files in it.

git clone -b main-azure https://github.com/microsoft/FluidHelloWorld.git

Navigate to the newly created folder, install dependencies, and start the app.

cd FluidHelloWorld
npm install
...
npm start

When you run the npm start command, two things will happen. First, a Fluid server will be launched in a local process. This server is intended for development only. You'll upgrade to an Azure-hosted production server later. Second, a new browser tab will open to a page that contains a new instance of the dice roller app. You can open new tabs with the same URL to create additional instances of the dice roller app. Each instance of the app is configured by default to use your local Fluid service. Click the Roll button in any instance of the app, and note that the state of the dice changes in every client.

Upgrading to Azure Fluid Relay

To run against the Azure Fluid Relay service, you'll need to update your app's configuration to connect to your Azure service instead of your local server.

Configure and create an Azure client

To configure the Azure client, replace the local connection serviceConfig object in app.js with your Azure Fluid Relay service configuration values. These values can be found in the "Access Key" section of the Fluid Relay resource in the Azure portal. Your serviceConfig object should look like this with the values replaced

const serviceConfig = {
    connection: {
        tenantId: "MY_TENANT_ID", // REPLACE WITH YOUR TENANT ID
        tokenProvider: new InsecureTokenProvider("" /* REPLACE WITH YOUR PRIMARY KEY */, { id: "userId" }),
        endpoint: "https://myServiceEndpointUrl", // REPLACE WITH YOUR SERVICE ENDPOINT
        type: "remote",
    }
};

Warning

During development, you can use InsecureTokenProvider to generate and sign authentication tokens that the Azure Fluid Relay service will accept. However, as the name implies, this is insecure and should not be used in production environments. The Azure Fluid Relay resource creation process provides you with a secret key which can be used to sign secure requests. To ensure that this secret doesn't get exposed, this should be replaced with another implementation of ITokenProvider that fetches the token from a secure, developer-provided backend service prior to releasing to production.

Build and run the client only

Now that you've pointed your app to use Azure instead of a local server, you don't need to launch the local Fluid server along with your client app. You can launch the client without also launching the server with this command.

npm run start:client

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