Start VS Project with Templates

Overview

This article provides instructions on how to start a Visual Studio project with templates.

This article applies to:

Prerequisites

A local DNN installation with Host permissions.
Visual Studio 2015 is the recommended IDE for developing DNN modules.

Information

Download and install the templates.
For Chris Hammond's templates,
1. Run Visual Studio as an administrator.
2. Go to Tools > Extensions and Updates.
3. Highlight the Online > Visual Studio Gallery tree and search for DotNetNuke.
4. Click the Download button for the DotNetNuke Project Templates.
Note: See Chris Hammond's instructions for other installation methods.

For the DNN 8 templates,
1. Download the appropriate .vsix file.
  Two are included:
  - Dnn.Mvc.Module.vsix
  - Dnn.Spa.Module.vsix
2. In your download folder, double-click the .vsix file to install the template in Visual Studio.
Create a new Visual Studio project.
1. Run Visual Studio as an administrator.
2. File > New > Project
3. Select the template for the new project.
  For Chris Hammond's templates, go to Installed > Templates > Visual C# or Visual Basic > DotNetNuke.
  
  For the DNN 8 templates, go to Installed > Templates > Visual C# > Dnn.
4. Fill in the settings.
  - Name: the name of your new module
  - Location: a subfolder inside the DesktopModules folder of your DNN installation folder
  Tip: Use your company name or a unique name as the subfolder name to avoid conflicts with other module creators in a production environment.
5. Uncheck Create directory for solution.
  The templates expect Visual Studio's solution file (.sln) to be in the same folder as the project file. Checking this option puts the solution file in a different folder, which can cause build errors.
Modify the Visual Studio project to add functionality to your new module.