Minimal Path to Awesome¶
The shortest way to prepare your local copy of the project for development and testing.
Before you start contributing to this project, you will need Node.js. This project has been tested with the 10.x version of Node.js and the version of NPM that comes with it. You can use Node Version Manager to switch between different versions of Node.js.
Get the local version of the project¶
- fork this repository
- clone your fork
- in the command line, run the following commands:
npm installto restore dependencies
npm install -g gulp-cliin order to run
npm list -g gulp-clito check if already installed on your machine or not)
gulp serveto serve your project (or
npm run serveif you want to use
- Start making your changes
Run the project locally¶
As this project embeds a SPFx solution, you have the ability to test all the controls on your machine.
As long as you have access to a SharePoint Online environment (for v2 and after), you can test the components from your machine. But to test the web part as a Teams Tab, you have to first deploy the SPFx solution (and sync it to Teams). You also have to deploy the SharePoint Framework library for Microsoft Graph Toolkit v2.9.0. So be sure to be at least SharePoint Administrator.
SPFx web part¶
The web part is called ControlsTest and is available for both SharePoint Online and Teams. To test it on SharePoint, go to the workbench page (https://[SHAREPOINT_SITE].sharepoint.com/_layouts/15/workbench.aspx) and add the web part.
To test it on Teams, once the project deployed on the tenant accordingly, add the web part as a Tab (from a team for example).
To update the host component, open the ControlsTest React component located in the following project's relative path: src\webparts\controlsTest\components\ControlsTest.tsx.
SPFx application customizer¶
This extension is called TestApplicationCustomizer. To test it, go to the following URL (after updating the parameters):
To update the host component, open the TestApp React component located in the following project's relative path: src\extensions\testApp\TestApp.tsx.
SPFx form customizer¶
This extension is called TestForm. To test it, you have to configure it first:
- Open the serve.json file (located in the config folder)
- Replace the
formCustomizer), which contains a server relative URL, to target the list on which you want to test the extension
Then go to the following URL (after updating the parameters):
To update the host component, open the TestForm React component located in the following project's relative path: src\extensions\testForm\components\TestForm.tsx.
SharePoint Framework React Controls uses MkDocs to publish documentation pages. See more information about installing MkDocs on your operating system at http://www.mkdocs.org/#installation.
Also, documentation uses custom MkDocs theme that should be installed as well. See Material theme for MkDocs.
Once you have MkDocs installed on your machine, in the command line:
cd ./docs/documentationto change directory to where the manual pages are stored
mkdocs serveto start the local web server with MkDocs and view the documentation in the web browser