32 строки
1.7 KiB
Markdown
32 строки
1.7 KiB
Markdown
# Welcome to the Fluid Framework Examples Repository!
|
|
|
|
This codebase includes examples of collaborative applications built with the Fluid Framework.
|
|
For documentation about the Fluid Framework, go to [FluidFramework.com](https://fluidframework.com/).
|
|
The Fluid Framework repository lives at [Github.com/Microsoft/FluidFramework](https://github.com/microsoft/fluidframework).
|
|
|
|
Each example in this repository is a standalone application that defines a Fluid Container and loads it into a webpage.
|
|
|
|
## Getting Started
|
|
|
|
To get started, clone the repository and navigate to one of the example folders.
|
|
From the example root, you can install and start the example.
|
|
|
|
1. Run `npm install` from the example root
|
|
2. Run `npm run start` to start both the client and server
|
|
|
|
> For more details see the individual example README.md.
|
|
|
|
## Contributing
|
|
|
|
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
|
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
|
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
|
|
|
|
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
|
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
|
provided by the bot. You will only need to do this once across all repos using our CLA.
|
|
|
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
|
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|