x-platform setup script for the SharePoint Starter Kit
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
resources
.gitignore
README.md
_create-hierarchy.sh
_functions.sh
_setup-hr.sh
_setup-marketing.sh
_setup-portal.sh
_setup-taxonomy.sh
_setup-tenant.sh
remove.sh
setup.sh
sharepoint-starter-kit.sppkg
theme.json

README.md

Setup bash script

Setup bash script for the PnP Starter Kit

Prerequisites

  • Install
  • Configure
    • Set the use who will run the setup script as a taxonomy term store admin
  • Execute
    • o365 spo connect [tenant admin], eg. o365 spo connect https://contoso-admin.sharepoint.com
    • o365 graph connect
    • chmod +x ./setup.sh

Setup

Execute the setup script by in the command line running: ./setup.sh --tenantUrl https://contoso.sharepoint.com --prefix pnp_.

Following are the options you can pass to the script:

argument description required default value example value
-t, --tenantUrl URL of the SharePoint tenant where the Starter Kit should be provisioned yes undefined https://contoso.sharepoint.com
-p, --prefix Prefix to use when provisioning sites to avoid conflicts with existing sites no (empty string) starterkit
--skipSolutionDeployment Don't deploy the solution package no false true
--skipSiteCreation Don't create sites no false true
--stockAPIKey API key to use with the Alpha Vantage API to retrieve stock information no (empty string) 12345
-c, --company Name of the organization to use when provisioning Starter Kit no Contoso Contoso
-w, --weatherCity City for which to display weather in the weather web part no Seattle Seattle
--stockSymbol Symbol of the stock to display in the stock web part no MSFT MSFT

Remove

To remove the Starter Kit, execute the uninstall script by in the command line running: ./remove.sh --tenantUrl https://contoso.sharepoint.com --prefix pnp_.

Following are the options you can pass to the script:

argument description required default value example value
-t, --tenantUrl URL of the SharePoint tenant where the Starter Kit should be provisioned yes undefined https://contoso.sharepoint.com
-p, --prefix Prefix to use when provisioning sites to avoid conflicts with existing sites no (empty string) starterkit
-c, --company Name of the organization to use when provisioning Starter Kit no Contoso Contoso