Skip to content

Latest commit

 

History

History

canvas

README.md

@fluid-example/canvas

Canvas is a Fluid Component that displays a collaborative canvas you can draw on.

Getting Started

Complete these steps to run the example:

  1. Run corepack enable to enable Corepack.
  2. From the FluidFramework root directory, run pnpm install.
  3. From the FluidFramework root directory, run pnpm run build:fast --nolint.
    • To build only this package, add the package name to the command: pnpm run build:fast --nolint @fluid-example/canvas
  4. Run pnpm start from this directory.
  5. Open http://localhost:8080 in a web browser.

To run the example with SharePoint, complete these steps:

  1. Follow the webpack-fluid-loader instructions to get authentication credentials.
  2. Run pnpm start:spo or pnpm start:spo-df from this directory.
  3. Open http://localhost:8080 in a web browser.

Data model

Canvas uses the following distributed data structures:

  • SharedDirectory - root
  • Ink - Append only stream designed for ink scenarios

Contribution Guidelines

You can contribute to Fluid Framework in these ways:

For detailed instructions, read the repo documentation.

This project follows the Microsoft Open Source Code of Conduct. For more information, read the Code of Conduct frequently asked questions. For questions or comments, contact opencode@microsoft.com.

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.

Help

Read the Fluid Framework documentation for information about Fluid Framework concepts and APIs.

To request information that the documentation does not contain, create an issue.

Trademark

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.