Skip to content

Latest commit

 

History

History

devtools-test-app

README.md

@fluid-example/devtools-example

This package contains a simple example application aimed at demonstrating how users can integrate Fluid's developer tools into their applications.

Note: while this example is built using React, the developer tools are not specific to React; they should be compatible with the view framework of your choice.

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-private/devtools-test-app
  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.

Test

To run the tests, first ensure you have followed the build steps above. Next, run npm run test from a terminal within this directory.

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.