-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated documentation and added support for teams
- Loading branch information
1 parent
324424d
commit e1342dc
Showing
3 changed files
with
50 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,43 @@ | ||
# Developer Guide | ||
|
||
TBD | ||
## Setup | ||
|
||
To setup download/clone the repo and run the following commands at root | ||
|
||
``` powershell | ||
npm install | ||
npm install -g yo gulp | ||
npm install -g @microsoft/generator-sharepoint | ||
``` | ||
|
||
Additional info for environment setup is available at [link](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-development-environment "link"). | ||
|
||
## Build | ||
|
||
``` powershell | ||
gulp clean | ||
gulp bundle | ||
``` | ||
|
||
## Debug | ||
|
||
``` powershell | ||
gulp serve | ||
``` | ||
|
||
This will launch the workbench where you can debug you web part. | ||
|
||
## Bundle and Package | ||
|
||
``` powershell | ||
gulp bundle --ship | ||
gulp package-solution --ship | ||
``` | ||
|
||
Files to deploy will be available at path `temp\deploy` and the package(*.sppkg) will be available at `sharepoint\solution` path. | ||
|
||
Make sure to update the `cdnBasePath` at `config\write-manifests.json` before deployment to the location where you have deployed your assets. | ||
|
||
Additional info for deployment is available at [link](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/deploy-web-part-to-cdn "link"). | ||
|
||
SPFx Documentation: [link](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/sharepoint-framework-overview "link") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters