Brainstorm is an example of using the Fluid Framework to build a collaborative line of business application. In this example each user can create their own sticky notes that is managed on a board.
To run this follow the steps below:
- Run
npm installfrom the brainstorm folder root - Run
npm run startto start both the client and server - Navigate to
http://localhost:8080in a browser tab
Brainstorm uses the following distributed data structures:
- SharedDirectory - root
- SharedMap - storing note information
- SharedMap - storing vote information
- SharedMap - storing user information
npm run buildRuns tsc and webpack and outputs the results in ./dist.
npm run startRuns both start:client and start:server.
npm run start:allUses webpack-dev-server to start a local webserver that will host your webpack file.
Once you run start you can navigate to http://localhost:8080 in any browser window to use your fluid example.
The Tinylicious Fluid server must be running. See
start:serverbelow.
npm run start:serverStarts an instance of the Tinylicious Fluid server running locally at http://localhost:3000.
Tinylicious only needs to be running once on a machine and can support multiple examples.
npm run start:testUses webpack-dev-server to start a local webserver that will host your webpack file.
Once you run start:test you can navigate to http://localhost:8080 in any browser window to test your fluid example.
start:test uses a Fluid server with storage to local tab session storage and launches two instances side by side. It does not require Tinylicious.
This is primarily used for testing scenarios.
npm run testRuns end to end test using Jest and Puppeteer.
npm run test:reportRuns npm run test with additional properties that will report success/failure to a file in ./nyc/*. This is used for CI validation.
Compiles the TypeScript code. Output is written to the ./dist folder.
Compiles and webpacks the TypeScript code. Output is written to the ./dist folder.