Set up a development environment for SharePoint Add-ins on Microsoft 365

Important

The SharePoint Add-In model in SharePoint Online has been retired as of November 27th 2023, checkout the full retirement announcement to learn more.

Retirement means that the feature will not get any new investments, but it's still supported. End-of-life means that the feature will be discontinued and is no longer available for use.

To get an understanding of your options before you carry out any procedures in this article, see Tools and environments for developing SharePoint Add-ins.

If you are not sure what kinds of SharePoint Add-ins you want to create, see SharePoint Add-ins.

Install Visual Studio and tools on your computer

Reference earlier versions of Visual Studio or other Visual Studio documentation.

Verbose logging in Visual Studio

Follow these steps if you want to turn on verbose logging:

  1. Open the registry, and go to HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\ nn.n\SharePointTools, where nn.n is the version of Visual Studio, such as 12.0 or 14.0.

  2. Add a DWORD key named EnableDiagnostics.

  3. Give the key the value 1.

The registry path will change in future versions of Visual Studio.

Sign up for a Microsoft 365 developer subscription

Note

You might already have access to a Microsoft 365 developer subscription:

To get a Microsoft 365 plan:

Open your developer site

Select the Build Add-ins link in the upper-left corner of the page to open your developer site. You should see a site that looks like the one in the following figure. The Add-ins in Testing list on the page confirms that the website was made with the SharePoint Developer Site template. If you see a regular team site instead, wait a few minutes and then restart your site.

Note

Make a note of the site's URL; it's used when you create SharePoint Add-in projects in Visual Studio.

Your developer site home page with the Add-ins in Testing list

Screenshot that shows the developer site homepage.

See also