• Stars
    star
    4,366
  • Rank 9,265 (Top 0.2 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created over 4 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Library for building distributed, real-time collaborative web applications

Fluid

The Fluid Framework is a library for building distributed, real-time collaborative web applications using JavaScript or TypeScript.

Getting started using the Fluid Framework

You may be here because you want to...

  • Learn more about the Fluid Framework
  • Build a Fluid object

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.

Using Fluid Framework libraries

When taking a dependency on a Fluid Framework library, we recommend using a ^ (caret) version range, such as ^1.3.4. While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries, library consumers should always prefer ^.

Code structure

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 several pnpm workspaces: some for individual packages and some for larger collections which we call "release groups". The workspaces are versioned separately from one another, but internally all packages in a workspaces are versioned together.

These workspaces do not align with package namespaces, and also don't always correspond to a single directory of this repo.

Here's the list of release group workspaces:

Here's a list of other sets of other packages (each package within these groups is versioned independently, forming its own release group):

  • "Common" Packages: miscellaneous packages in the ./common directory and published under the @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.
  • "Tools" Packages: miscellaneous packages in the ./tools directory and published under a variety of namespaces. Logically about the same as "Common", but most of the names include "tools" instead of "common".
  • Auxiliary Microservice Packages (supporting Routerlicious)
    • ./server excluding routerlicious, gitrest and historian (Published in the @fluidframework/ namespace)
  • ./docs: The code and content for https://fluidframework.com.

Dependencies between packages in various layers of the system are enforced via a build step called layer-check. You can view the full list of packages and layers in PACKAGES.md.

  • Note: to update the contents of PACKAGES.md for local package changes, run pnpm layer-check --md ..

Setup and Building

Install the required tools:

Clone a copy of the repo and change to the repo root directory:

git clone https://github.com/microsoft/FluidFramework.git
cd FluidFramework

Enable NodeJs's corepack:

corepack enable

Run the following to build the client packages:

pnpm install
npm run build

You can use the experimental worker mode to get faster build time as well: npm run build:fast

See also: Contributing

Build in VSCode

To build Fluid Framework within VSCode, open the Fluid Framework repo folder as a work space and use Ctrl-Shift-B to activate the build task. It is the same as running npm run build on the command line.

NodeJs Installation

We recommend using nvm (for Windows or MacOS/Linux) or fnm to install Node.js. This ensures you stay at the correct version while allowing other uses of NodeJS to use the (possibly different) versions they need side-by-side.

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 node-gyp's documentation):

On Windows

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

On Unix

  1. Python v3.7, v3.8, v3.9, or v3.10
  2. make
  3. A C/C++ toolchain (like GCC)

On MacOS

If you've upgraded your Mac to Catalina or higher, you may need to follow these instructions.

  1. Python v3.7, v3.8, v3.9, or v3.10
  2. XCode Command Line Tools, which will install make, clang, and clang++
    • You can install these by running xcode-select --install from a command line.

Other Build Requirements

  • Building server/Routerlicious
    • Refer to that package's README for additional requirements.
    • Note that these requirements do not affect all workflows (e.g. the one noted above), but will affect workflows that include the packages under server (e.g. fluid-build --symlink:full).

On Windows

  • Ensure that you have enabled running Powershell scripts by setting your environment's Execution Policy.

Other Build Commands

Building our docs

There are a few different areas in which we generate documentation content as a part our overall build.

  1. fluidframework.com
    • We build the contents of our public website from the docs directory under the root of this repo. See its README for more details.
  2. Generated README contents
    • We leverage a local tool (markdown-magic) to generate / embed contents in our various package-level READMEs. This is done as a part of a full build, but it can also be executed in isolation by running npm run build:readme from the repo root.
  3. API reports
    • We leverage API-Extractor to generate summaries of our package APIs. This is done as a part of a full build, but it can also be executed in isolation by running npm run build:api from the repo root.

Testing

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 test 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, ensure you have installed Git LFS. Then, from the repo root:

git lfs install
git submodule init
git submodule update

Run the tests

npm run test

Include code coverage

npm run test:coverage

Mimic the official CI build

Our CI pipelines run on Linux machines, and the npm scripts all have the ci prefix. To replicate the test steps from the CI pipeline locally, run the following commands for the packages or pnpm workspaces:

Run Non-Windows Windows
PR npm run ci:test npm run test:report && npm run test:copyresults
Official npm run ci:test:coverage npm run test:coverage && npm run test:copyresults

Run tests from within VS Code

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".

Run it locally

Single browser window, two panes

This will use an in-memory implementation of the Fluid server to sync between the two panes in the browser window.

  • Choose an example under /examples
  • Navigate to the example's directory, e.g. /examples/data-objects/clicker
  • npm run start
  • Browse to http://localhost:8080 to interact with two copies of the example side-by-side

Multiple browser instances on the same device

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 /server/routerlicious/:

pnpm install

Then these commands from /server/routerlicious/packages/tinylicious:

pnpm run build
pnpm run start

Then:

  • Navigate to the example of your choice (same as above)
  • npm run start:tinylicious
  • Browse to http://localhost:8080, copy the full URL you're redirected to, and open in a second window to collaborate

Tools

Prettier

This repository uses prettier as its code formatter. Right now, this is implemented on a per-package basis, with a shared base configuration.

  • To run prettier on your code, run npm run format from the appropriate package or release group, or run npm run format:changed from the root of the repo to format only files changed since the main branch. If your change is for the next branch instead, you can run npm run format:changed:next.
  • To run prettier with fluid-build, you can specify "format" via the script argument: fluid-build -t format or npm run build:fast -- -t format

To ensure our formatting remains consistent, we run a formatting check as a part of each package's lint script.

VSCode Options

Our workspace configuration specifies prettier as the default formatter. Please do not change this.

It is not configured to do any formatting automatically, however. This is intentional, to ensure that each developer can work formatting into their workflow as they see fit. If you wish to configure your setup to format on save/paste/etc., please feel free to update your user preferences to do so.

Notable setting options:

  • format on save
  • format on paste

User editor formatting setting options

Git Configuration

Run the following command in each of your repositories to ignore formatting changes in git blame commands: git config --local blame.ignoreRevsFile .git-blame-ignore-revs

Developer notes

Root dependencies

The root package.json in the repo includes devDependencies on the mocha and jest testing tools. This is to enable easier test running and debugging using VSCode. However, this makes it possible for projects to have a 'phantom dependency' on these tools. That is, because mocha/jest is always available in the root, projects in the repo will be able to find mocha/jest even if they don't express a dependency on those packages in their package.json. We have lint rules in place to prevent phantom dependencies from being introduced but they're not foolproof.

Contributing

There are many ways to contribute to Fluid.

Detailed instructions for working in the repo can be found in the Wiki.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

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.

More Repositories

1

vscode

Visual Studio Code
TypeScript
157,226
star
2

PowerToys

Windows system utilities to maximize productivity
C#
103,126
star
3

TypeScript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TypeScript
96,979
star
4

terminal

The new Windows Terminal and the original Windows console host, all in the same place!
C++
93,068
star
5

Web-Dev-For-Beginners

24 Lessons, 12 Weeks, Get Started as a Web Developer
JavaScript
81,067
star
6

ML-For-Beginners

12 weeks, 26 lessons, 52 quizzes, classic Machine Learning for all
HTML
65,262
star
7

playwright

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript
60,055
star
8

monaco-editor

A browser based code editor
JavaScript
35,437
star
9

generative-ai-for-beginners

18 Lessons, Get Started Building with Generative AI 🔗 https://microsoft.github.io/generative-ai-for-beginners/
Jupyter Notebook
31,194
star
10

AI-For-Beginners

12 Weeks, 24 Lessons, AI for All!
Jupyter Notebook
30,214
star
11

calculator

Windows Calculator: A simple yet powerful calculator that ships with Windows
C++
27,371
star
12

DeepSpeed

DeepSpeed is a deep learning optimization library that makes distributed training and inference easy, efficient, and effective.
Python
26,923
star
13

Data-Science-For-Beginners

10 Weeks, 20 Lessons, Data Science for All!
Jupyter Notebook
26,023
star
14

cascadia-code

This is a fun, new monospaced font that includes programming ligatures and is designed to enhance the modern look and feel of the Windows Terminal.
Python
23,884
star
15

autogen

A programming framework for agentic AI. Join our Discord: https://discord.gg/pAbnFJrkgZ
Jupyter Notebook
23,491
star
16

JARVIS

JARVIS, a system to connect LLMs with ML community. Paper: https://arxiv.org/pdf/2303.17580.pdf
Python
22,801
star
17

api-guidelines

Microsoft REST API Guidelines
22,149
star
18

winget-cli

WinGet is the Windows Package Manager. This project includes a CLI (Command Line Interface), PowerShell modules, and a COM (Component Object Model) API (Application Programming Interface).
C++
20,495
star
19

vcpkg

C++ Library Manager for Windows, Linux, and MacOS
CMake
19,600
star
20

fluentui

Fluent UI web represents a collection of utilities, React components, and web components for building web applications.
TypeScript
17,524
star
21

CNTK

Microsoft Cognitive Toolkit (CNTK), an open source deep-learning toolkit
C++
17,412
star
22

MS-DOS

The original sources of MS-DOS 1.25 and 2.0, for reference purposes
Assembly
17,220
star
23

unilm

Large-scale Self-supervised Pre-training Across Tasks, Languages, and Modalities
Python
17,032
star
24

WSL

Issues found on WSL
PowerShell
16,488
star
25

recommenders

Best Practices on Recommendation Systems
Python
16,075
star
26

LightGBM

A fast, distributed, high performance gradient boosting (GBT, GBDT, GBRT, GBM or MART) framework based on decision tree algorithms, used for ranking, classification and many other machine learning tasks.
C++
15,890
star
27

react-native-windows

A framework for building native Windows apps with React.
C++
15,855
star
28

AirSim

Open source simulator for autonomous vehicles built on Unreal Engine / Unity, from Microsoft AI & Research
C++
15,545
star
29

IoT-For-Beginners

12 Weeks, 24 Lessons, IoT for All!
C++
14,552
star
30

semantic-kernel

Integrate cutting-edge LLM technology quickly and easily into your apps
C#
14,400
star
31

Bringing-Old-Photos-Back-to-Life

Bringing Old Photo Back to Life (CVPR 2020 oral)
Python
14,132
star
32

dotnet

This repo is the official home of .NET on GitHub. It's a great starting point to find many .NET OSS projects from Microsoft and the community, including many that are part of the .NET Foundation.
HTML
14,026
star
33

qlib

Qlib is an AI-oriented quantitative investment platform that aims to realize the potential, empower research, and create value using AI technologies in quantitative investment, from exploring ideas to implementing productions. Qlib supports diverse machine learning modeling paradigms. including supervised learning, market dynamics modeling, and RL.
Python
13,919
star
34

nni

An open source AutoML toolkit for automate machine learning lifecycle, including feature engineering, neural architecture search, model compression and hyper-parameter tuning.
Python
13,084
star
35

ai-edu

AI education materials for Chinese students, teachers and IT professionals.
HTML
12,952
star
36

pyright

Static Type Checker for Python
Python
11,792
star
37

guidance

A guidance language for controlling large language models.
Jupyter Notebook
11,777
star
38

TypeScript-Node-Starter

A reference example for TypeScript and Node with a detailed README describing how to use the two together.
SCSS
11,224
star
39

Swin-Transformer

This is an official implementation for "Swin Transformer: Hierarchical Vision Transformer using Shifted Windows".
Python
11,187
star
40

TypeScript-React-Starter

A starter template for TypeScript and React with a detailed README describing how to use the two together.
TypeScript
11,081
star
41

frontend-bootcamp

Frontend Workshop from HTML/CSS/JS to TypeScript/React/Redux
TypeScript
10,797
star
42

language-server-protocol

Defines a common protocol for language servers.
HTML
10,093
star
43

onnxruntime

ONNX Runtime: cross-platform, high performance ML inferencing and training accelerator
C++
9,837
star
44

windows-rs

Rust for Windows
Rust
9,654
star
45

wslg

Enabling the Windows Subsystem for Linux to include support for Wayland and X server related scenarios
C++
9,626
star
46

sql-server-samples

Azure Data SQL Samples - Official Microsoft GitHub Repository containing code samples for SQL Server, Azure SQL, Azure Synapse, and Azure SQL Edge
9,367
star
47

computervision-recipes

Best Practices, code samples, and documentation for Computer Vision.
Jupyter Notebook
9,264
star
48

napajs

Napa.js: a multi-threaded JavaScript runtime
C++
9,256
star
49

Windows-universal-samples

API samples for the Universal Windows Platform.
JavaScript
9,253
star
50

mimalloc

mimalloc is a compact general purpose allocator with excellent performance.
C
9,165
star
51

vscode-tips-and-tricks

Collection of helpful tips and tricks for VS Code.
9,038
star
52

playwright-python

Python version of the Playwright testing and automation library.
Python
8,990
star
53

STL

MSVC's implementation of the C++ Standard Library.
C++
8,978
star
54

fast

The adaptive interface system for modern web experiences.
TypeScript
8,958
star
55

react-native-code-push

React Native module for CodePush
C
8,643
star
56

fluentui-emoji

A collection of familiar, friendly, and modern emoji from Microsoft
Python
8,487
star
57

reactxp

Library for cross-platform app development.
TypeScript
8,308
star
58

LoRA

Code for loralib, an implementation of "LoRA: Low-Rank Adaptation of Large Language Models"
Python
8,153
star
59

vscode-extension-samples

Sample code illustrating the VS Code extension API.
TypeScript
7,779
star
60

reverse-proxy

A toolkit for developing high-performance HTTP reverse proxy applications.
C#
7,702
star
61

inshellisense

IDE style command line auto complete
TypeScript
7,675
star
62

c9-python-getting-started

Sample code for Channel 9 Python for Beginners course
Jupyter Notebook
7,642
star
63

ailab

Experience, Learn and Code the latest breakthrough innovations with Microsoft AI
C#
7,604
star
64

cpprestsdk

The C++ REST SDK is a Microsoft project for cloud-based client-server communication in native code using a modern asynchronous C++ API design. This project aims to help C++ developers connect to and interact with services.
C++
7,573
star
65

WSL2-Linux-Kernel

The source for the Linux kernel used in Windows Subsystem for Linux 2 (WSL2)
C
7,430
star
66

botframework-sdk

Bot Framework provides the most comprehensive experience for building conversation applications.
JavaScript
7,272
star
67

azuredatastudio

Azure Data Studio is a data management and development tool with connectivity to popular cloud and on-premises databases. Azure Data Studio supports Windows, macOS, and Linux, with immediate capability to connect to Azure SQL and SQL Server. Browse the extension library for more database support options including MySQL, PostreSQL, and MongoDB.
TypeScript
7,182
star
68

winget-pkgs

The Microsoft community Windows Package Manager manifest repository
6,981
star
69

Windows-driver-samples

This repo contains driver samples prepared for use with Microsoft Visual Studio and the Windows Driver Kit (WDK). It contains both Universal Windows Driver and desktop-only driver samples.
C
6,568
star
70

winfile

Original Windows File Manager (winfile) with enhancements
C
6,437
star
71

nlp-recipes

Natural Language Processing Best Practices & Examples
Python
6,320
star
72

WinObjC

Objective-C for Windows
C
6,229
star
73

SandDance

Visually explore, understand, and present your data.
TypeScript
6,091
star
74

MixedRealityToolkit-Unity

This repository is for the legacy Mixed Reality Toolkit (MRTK) v2. For the latest version of the MRTK please visit https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity
C#
5,943
star
75

vscode-go

An extension for VS Code which provides support for the Go language. We have moved to https://github.com/golang/vscode-go
TypeScript
5,937
star
76

VFSForGit

Virtual File System for Git: Enable Git at Enterprise Scale
C#
5,918
star
77

microsoft-ui-xaml

Windows UI Library: the latest Windows 10 native controls and Fluent styles for your applications
5,861
star
78

GSL

Guidelines Support Library
C++
5,850
star
79

vscode-recipes

JavaScript
5,802
star
80

MMdnn

MMdnn is a set of tools to help users inter-operate among different deep learning frameworks. E.g. model conversion and visualization. Convert models between Caffe, Keras, MXNet, Tensorflow, CNTK, PyTorch Onnx and CoreML.
Python
5,772
star
81

ethr

Ethr is a Comprehensive Network Measurement Tool for TCP, UDP & ICMP.
Go
5,642
star
82

FASTER

Fast persistent recoverable log and key-value store + cache, in C# and C++.
C#
5,630
star
83

rushstack

Monorepo for tools developed by the Rush Stack community
TypeScript
5,502
star
84

DirectX-Graphics-Samples

This repo contains the DirectX Graphics samples that demonstrate how to build graphics intensive applications on Windows.
C++
5,440
star
85

vscode-docs

Public documentation for Visual Studio Code
Markdown
5,423
star
86

fluentui-system-icons

Fluent System Icons are a collection of familiar, friendly and modern icons from Microsoft.
HTML
5,377
star
87

vscode-cpptools

Official repository for the Microsoft C/C++ extension for VS Code.
TypeScript
5,315
star
88

BosqueLanguage

The Bosque programming language is an experiment in regularized design for a machine assisted rapid and reliable software development lifecycle.
TypeScript
5,282
star
89

DeepSpeedExamples

Example models using DeepSpeed
Python
5,092
star
90

promptbase

All things prompt engineering
Python
4,927
star
91

TypeScript-Handbook

Deprecated, please use the TypeScript-Website repo instead
JavaScript
4,881
star
92

Detours

Detours is a software package for monitoring and instrumenting API calls on Windows. It is distributed in source code form.
C++
4,811
star
93

tsyringe

Lightweight dependency injection container for JavaScript/TypeScript
TypeScript
4,700
star
94

Windows-classic-samples

This repo contains samples that demonstrate the API used in Windows classic desktop applications.
4,684
star
95

vscode-dev-containers

NOTE: Most of the contents of this repository have been migrated to the new devcontainers GitHub org (https://github.com/devcontainers). See https://github.com/devcontainers/template-starter and https://github.com/devcontainers/feature-starter for information on creating your own!
Shell
4,659
star
96

tsdoc

A doc comment standard for TypeScript
TypeScript
4,617
star
97

SPTAG

A distributed approximate nearest neighborhood search (ANN) library which provides a high quality vector index build, search and distributed online serving toolkits for large scale vector search scenario.
C++
4,603
star
98

WPF-Samples

Repository for WPF related samples
C#
4,545
star
99

TypeScript-Vue-Starter

A starter template for TypeScript and Vue with a detailed README describing how to use the two together.
JavaScript
4,458
star
100

SynapseML

Simple and Distributed Machine Learning
Scala
4,335
star