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.

If you don't have one, you can get a Microsoft 365 developer subscription when you join the Microsoft 365 Developer Program. See the Microsoft 365 Developer Program documentation for step-by-step instructions about how to join the Microsoft 365 Developer Program and sign up and configure your subscription.

Note

Make sure that you are signed out of any existing Microsoft 365 tenants before you sign up for the Microsoft 365 Developer Program.

You can also follow these steps by watching this video on the SharePoint 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, see Create app catalog sites.

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.

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

  3. Locate the section Apps and select Open.

  4. On the Apps page, select App Catalog.

  5. Select OK to create a new app catalog site.

  6. On the next page, enter the following details:

    • Title: Enter app catalog.
    • Web Site Address suffix: Enter your preferred suffix for the app catalog; for example: apps.
    • Administrator: Enter your username, and then select the resolve button to resolve the username.
  7. Select OK to create the app catalog site.

SharePoint creates the app catalog site, and you can see its progress in the SharePoint admin center.

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:

    https://{your-tenant-prefix}-admin.sharepoint.com
    
  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 page, select Team site.

  5. In the panel that appears, enter required details to create the site (name, 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 same tenant for developing SharePoint Framework experiences, especially for initial development experiences. We do however recommend to use isolated developer tenants for each of the developers for best isolated developer experience.

SharePoint Workbench

SharePoint Workbench is a developer design surface that enables you to quickly preview and test web parts without deploying them in SharePoint. SharePoint Framework developer toolchain contains a version of the Workbench that works locally and helps you quickly test and validate solutions that you're building.

It's also hosted in your tenant to preview and test your local web parts in development. You can access the Hosted SharePoint Workbench from any SharePoint site in your tenancy by browsing to the following URL:

https://your-sharepoint-site/_layouts/workbench.aspx

Next steps

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