You may be here because you want to...
Documentation and guides can be found at https://fluidframework.com/.
Hello World repo can be found at https://github.com/microsoft/FluidHelloWorld.
Core Examples repo can be found at https://github.com/microsoft/FluidExamples.
Have questions? Engage with other Fluid Framework users and developers in the [Discussions] section of our GitHub repo.
The core code for both the Fluid client packages and the reference ordering service is contained within this repo.
The repo structure is somewhat unique because it contains five monorepos as well as several standalone packages. The monorepos are managed using Lerna and are versioned separately from one another, but internally all packages in a monorepo are versioned together. Outside the monorepos there are plenty of packages which are versioned independently.
These monorepos (which also serve as "release groups") do not necessary align with package namespaces, and also don't necessary correspond to a single directory of this repo.
Here's the list of Lerna managed release groups:
Here's a list of other sets of other packages (each package within these groups is versioned independently, forming its own release group):
@fluidframework/namespace. Most of these (but not all) have "common" in their package name. Packages which are used by multiple other groups of packages (such as built tools, linter configs and protocol definitions) live here.
Because of a transitive dependency on a native addon module, you'll also need to ensure that you have the prerequisites for
node-gyp. Depending on your operating system, you'll have slightly different installation requirements (these are largely copied from
The node installer should ask if you want to install "Tools for Native Modules." If you check the box for this nothing further should be needed. Otherwise, you can follow the steps listed here
If you've upgraded your Mac to Catalina or higher, you may need to follow these instructions.
XCode Command Line Tools, which will install
xcode-select --installfrom a command line.
Clone a copy of the repo and change to the repo root directory:
git clone https://github.com/microsoft/FluidFramework.git cd FluidFramework
Run the following to build the client packages:
npm install npm run build:fast
See also: Contributing
You can run all of our tests from the root of the repo, or you can run a scoped set of tests by running the
command from the package you're interested in.
Note: Some of the tests depend on test collateral that lives in a submodule here: https://github.com/microsoft/FluidFrameworkTestData. You may choose to fetch that collateral into your local repository, which is required to run all the tests - otherwise some will be skipped.
First install Git LFS from https://git-lfs.github.com/. Then, from the repo root:
git lfs install git submodule init git submodule update
npm run test
npm run test:coverage
Our CI pipelines run on Linux machines, and the npm scripts all have the
To replicate the test steps from the CI pipeline locally, run the following commands for the packages or Lerna monorepos:
We've checked in VS Code configuration
enabling F5 from a
spec.ts file to run those tests if you set the debug configuration to "Debug Current Test".
This will use an in-memory implementation of the Fluid server to sync between the two panes in the browser window.
npm run start
This will run the local Fluid server implementation we call "Tinylicious", so you can sync between multiple browser instances.
First, start Tinylicious by running these commands from
npm install npm run build npm run start
npm run start:tinylicious
There are many ways to contribute to Fluid.
Detailed instructions for working in the repo can be found in the Wiki.
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. Use of these trademarks or logos must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.