Skip to content

Latest commit

 

History

History

inventory-app

README.md

@fluid-example/inventory-app

Minimal sample demonstrating use of the SharedTree API.

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/inventory-app
  4. Run pnpm start from this directory and open http://localhost:8080 in a web browser. The app uses a session-storage-backed in-browser service by default and stores the container ID in the URL hash.
  5. To select the session-backed service explicitly, run pnpm start:session and open http://localhost:8080/?fluidClient=session.
  6. To share data between browser sessions, start Tinylicious in a separate terminal by running pnpm tinylicious in this directory, then run pnpm start:tinylicious and open http://localhost:8080/?fluidClient=tinylicious. If you use GitHub Codespaces in a browser, set the visibility of the Tinylicious port (7070) to public. Do not use Private to Organization. For instructions, read Sharing a port.

Testing

npm run test

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.

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.