sp-dev-fx-webparts/samples/react-rhythm-of-business-ca...
Hugo Bernier 411f1b1eca Changed authors to contributors 2023-02-18 22:58:44 -05:00
..
assets Fixed ROB screenshots 2022-12-31 17:12:21 -05:00
build Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
config Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
documentation Deep-dive documentation for the SPFx Solution Accelerator 2022-11-11 16:57:25 -08:00
mock_modules/@microsoft Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
src Deep-dive documentation for the SPFx Solution Accelerator 2022-11-11 16:57:25 -08:00
teams Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
.editorconfig Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
.eslintrc.js Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
.gitattributes Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
.gitignore Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
.yo-rc.json Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
README.md Changed authors to contributors 2023-02-18 22:58:44 -05:00
environments.json Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
gulpfile.js Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
jest.config.js Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
jest.setup.localization-mocks.ts Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00
package-lock.json Bump json5 in /samples/react-rhythm-of-business-calendar 2023-01-01 02:43:43 -05:00
package.json Bump json5 in /samples/react-rhythm-of-business-calendar 2023-01-01 02:43:43 -05:00
tsconfig.json Initial commit of Rhythm of Business Calendar app sample (#1) 2022-09-21 15:35:23 -07:00

README.md

Rhythm of Business Calendar

Summary

This sample is the source code for the Rhythm of Business Calendar app and is intended to demonstrate patterns and practices for building enterprise apps on the SharePoint platform.

Rhythm of Business (RoB) Calendar keeps you on top of your business goals by managing all team and organizational events seamlessly. Simplify and expedite the coordination and planning process for your team and subgroups with the help of color-coded events, approval workflow, refiners and confidential events. Ideal for Chiefs of Staff, Executive Assistants, or anyone who manages a team calendar, you can empower your teams by enabling better insights on your business goals and team events.

Month view
Screenshot of month view

View event details
Screenshot of view event panel

Edit refiner
Screenshot of edit refiner panel

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

SPFx 1.15 Node.js v16 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers Teams Yes: Designed for Microsoft Teams

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Contributors

Version history

Version Date Comments
1.0 September 26, 2022 Initial release

Minimal path to awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)
  • From your command line, change your current directory to the directory containing this sample (react-rhythm-of-business-calendar, located under samples)
  • in the command line run:
    • npm install
    • gulp serve --nobrowser

Features

This sample is a complete app that demonstrates the "SPFx Solution Accelerator" framework, along with patterns and practices for building enterprise-class apps on SharePoint. Inspired by Domain Driven Design and Onion Architecture, this accelerator has evolved since SPFx v1.0, and we want to share it with the world!

At a high-level, the accelerator includes the following features:

  • Prescribed solution structure separates web parts, components, model, services, and schema (data) layers
  • Robust entity domain model with relationships, validation, change tracking, and text search
  • Robust schema provisioning and versioning; use SharePoint lists as a simple relational database
  • Services for interacting with SharePoint, timezones, domain isolation, and users and groups, plus patterns for building custom services for app-specific logic
  • Component library with customizable wizard, panel/dialog for quickly building view/edit screens, validation, and more
  • Live Update feature ensures users are always working with the latest data without manaually reloading the page
  • Built on the latest SPFx with TypeScript, React, and Fluent UI, plus PnPjs, Moment.js, Lodash, and Jest

A deep dive into the various features of the accelerator can be found in the documentation folder.

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.