79ae49b23e
on-behalf-of: @Azure opensource@microsoft.com |
||
---|---|---|
.github/workflows | ||
public | ||
src | ||
.gitattributes | ||
.gitignore | ||
README.md | ||
package-lock.json | ||
package.json | ||
tsconfig.json |
README.md
Lets Brainstorm
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. Ideas that have been "liked" appear in a list and are sorted based upon the number likes.
Running the App Locally with Tinylicious as the Fluid Service
To run this follow the steps below:
- Open a terminal window at the root of the project.
- Run
npm install
from the root - Run
npm start
to start the client - Run
npx tinylicious
to start the "Tinylicious" test service locally (this is used for local development) - Navigate to
http://localhost:3000
in a browser tab
This package is based on the Create React App, so much of the Create React App documentation applies.
Running the App Locally with Azure Relay Service as the Fluid Service
To run this follow the steps below:
- Go to the Azure portal and search for
Azure Fluid Relay
. - Create a new Azure Fluid Relay resource and note the
tenantId
,token
, andorderer
andstorage
values. - Rename the
.env-template
file in the root of the project to.env
. - Replace the values in the
.env
file with the appropriate values from the Azure portal. - Open a terminal window at the root of the project.
- Run
npm install
from the root - Run
export REACT_APP_FLUID_CLIENT=frs
in the terminal to create an environment variable (if using PowerShell run$env:REACT_APP_FLUID_CLIENT='frs'
). This will cause the app to use FRS instead of Tinylicious for the Fluid service. ) - Run
npm start
to start the client - Navigate to
http://localhost:3000
in a browser tab
Using the Brainstorm App
- Navigate to
http://localhost:3000
You'll be taken to a url similar to 'http://localhost:3000/#a9c16d13-43fa-413a-859c-514e5bcaba3c' the path #a9c16d13-43fa-413a-859c-514e5bcaba3c
specifies one brainstorm document.
- Create another chrome tab with
http://localhost:3000/**#a9c16d13-43fa-413a-859c-514e5bcaba3c**
Now you can create notes, write text, change colors and more!