Edit

Set up your Microsoft 365 tenant

To build and deploy client-side web parts using the SharePoint Framework, you need a Microsoft 365 tenant.

If you already have a Microsoft 365 tenant, see the section Create app catalog site.

Important

SharePoint Add-ins reached end of life in SharePoint Online on April 2, 2026 and no longer work there. This retirement does not affect SharePoint Framework (SPFx), the recommended replacement for SharePoint Add-in user interface extensions. SPFx continues to be supported. SharePoint Server Add-ins deployed through an on-premises app catalog are not retired by this change.

See more on the SharePoint add-in model retirement from the full add-in model retirement announcement.

If you don't have a Microsoft 365 tenant, you might qualify for one through the Microsoft 365 Developer Program; for details, see the FAQ. Alternatively, you can sign up for a 1-month free trial or purchase a Microsoft 365 plan.

You can also follow these steps by watching this video on the Microsoft 365 Platform Communtiy (PnP) YouTube Channel:

Create app catalog site

You need an app catalog to upload and deploy web parts. If you've already set up an app catalog, continue to Create a new site collection.

To create an app catalog site

  1. Go to the SharePoint Admin Center by entering the following URL in your browser. Replace yourtenantprefix with your Microsoft 365 tenant prefix.

    Commercial Tenant

    https://{your-tenant-prefix}-admin.sharepoint.com
    

    GCC High Tenant

    https://{your-tenant-prefix}-admin.sharepoint.us
    
  2. In the left sidebar, select More features

  3. Locate the section Apps and select Open.

This will start the automatic creation of the SharePoint app catalog to the tenant if it does not exist. If the app catalog already exists, you will be redirect to it. SharePoint app catalog is used to manage and deploy SharePoint Framework solutions.

Create a new site collection

You also need a site collection and a site for your testing. You can create a new site collection by using any of the available templates.

  1. Navigate to SharePoint Admin Center by entering the following URL in your browser. Replace {your-tenant-prefix} with your Microsoft 365 tenant prefix:

    Commercial Tenant

    https://{your-tenant-prefix}-admin.sharepoint.com
    

    GCC High Tenant

    https://{your-tenant-prefix}-admin.sharepoint.us
    
  2. In the left sidebar, select Sites > Active sites.

  3. Select Create from the toolbar at the top of the page.

  4. On the Create a site panel, select Team site.

  5. In the new view that appears, enter required details to create the site (Site name, Group owner, and language):

  6. Select Next to create the site collection.

After SharePoint creates the site, you can browse to your site collection by selecting Finish & entering the URL of the new site.

Note

In this case, we are creating a new group associated team site with modern user interface experience. You could just as well create a communication site to be used as your test site collection supporting your development.

Note

You can potentially use the same tenant for developing SharePoint Framework experiences, especially for initial development experiences. We do, however, recommend the use of isolated developer tenants for each developer, for the best isolated developer experience.

Set up a page for debugging

Create a modern SharePoint page in your development site and make sure your developer account can edit it. Use this page to test locally served web parts in their actual SharePoint context, with the SharePoint Framework Debug Toolbar (developer toolbar). Extensions require an appropriate modern page, list, or library for their extension type. See Debug SharePoint Framework solutions on modern SharePoint pages.

The local workbench was removed in SPFx 1.13 and isn't included in current projects.

Important

The SharePoint Framework Online workbench is deprecated starting on May 13, 2026 and will be retired on December 1, 2026.

For web parts, debug on actual SharePoint pages using the SharePoint Framework Debug Toolbar (developer toolbar). See Debug SharePoint Framework solutions on modern SharePoint pages.

This deprecation does not apply to the Copilot Workbench, which is fully supported for developing and testing Copilot UX components.

For Copilot UX components, use the fully supported Copilot Workbench. Development and testing, including Copilot Workbench, require the Microsoft 365 Copilot add-on license on top of your normal E3, E5, or E7 license, just as production use does. Eligibility for a Microsoft 365 developer subscription doesn't replace this requirement. See the Copilot UX component licensing and availability requirements.

Next steps

Now that you've configured your SharePoint tenant, set up your development environment to build client-side web parts.