Skip to main content

Deploy spkg app package solution (SPFX) to SharePoint Online

Determine whether you need to deploy the solution to all sites or a specific site collection.

Deploy spkg solution (SPFx) to all Sites​

Prerequisite​

  • Ensure the spkg package is prepared correctly.
  • Dedicated app catalog site.
  1. Go to Apps for SharePoint (aka App catalog site).
  2. Click Upload and select the spkg package.
  3. Select "Add to all sites" option.
  4. Confirm the upload and ensure there are no errors.
  5. Verifify that the app is availalbe in the App Catalog as well as in a test site of your choice.

Site Collection Specific Deployment​

Prequisite​

  • After peparing the spkg package, ensure that the app is uploaded in a dedicated app catalog and is marked as "Added to All sites" - No, with no errors message for the package.
  1. Go to Site Contents of the target site collection.
  2. Click New>App
  3. Select the app that you want to deploy to the site collection.

!!! note

Don't see the app? Check to ensure the app is deployed in a dedeicated app catalog for the tenant.

Packaing the project for deployment​

Steps.

  1. run gulp bundle
  2. run gulp package-solution.
  3. Go to /sharepoint/solutions folder and identify a file with .sppkg extension. Grab this file for deployment.