DNN Module Template w/ WebApi & AngularJS

This template is a base starting point for building highly performant client side applications with AngularJS, RxJS, and Asp.Net WebApi

Installation

1. Install DNN (DNN 7.3+ required)
2. Create company folder in /DesktopModules/
3. Create module folder in /DesktopModules/{CompanyName}
4. Clone this repository into the module folder.
5. Run Setup Template.ps1 powershell script
6. Provider powershell script with your CompanyName & ModuleName

Happy coding!

Basics

• You will start by building Entity classes in /Components/Entities.
• Next you will create a *Repository to map to your entity in /Components/Data.
• You can then use your Respository in the provided /Components/WebApi/* controller or you can create your own.
• Now you will shift from the server to the client by updating the /Client/Common/Services/Api.ts to pull in your data from the server.
• At this point you can utilize individual /Views or use UI-Route w/ templates.

DNN Features

• Loader.ascx will inject any of the Views located in the /Views folder.
• AngularJS files are automatically injected into the page by naming convention. Files in /Client/Common subdirectories will be added to every view. Additional files will be added based on the View name selected. ex. (/Views/Main.ascx will load /Client/Main/*).
• AngularJS files are added using DNN's Client Dependency Framework utilizing the ForceProvider="DnnFormBottomProvider" attribute in order for all files to be added to the bottom of the body.
• AngularJS files use the long-form instantiation method in order to be minify safe.
• Uses DAL2 PetaPoco with the Repository pattern for the Data Access Layer.
• All dependencies are added as Nuget packages and can be found in the Packages.config
• CustomModuleBase.cs handles most of the DNN user control injection logic. Also injects the client side dependencies.
• CustomSettings.cs is like ModuleSettings but strongly named for your module. It's available in all views.
• Scaffold for DNN Scheduler
• Scaffold for Sitemap provider.

Additional scaffolds coming soon for Import/Export and more...

Note: you must set the project from debug to release mode for installation zips to be created.

Misc Features

• MSBuild scripts are used to package the module into Install & Source zips located in the /Install directory.
• DLL depdendencies are pulled out of the .dnn manifest and included in the install & source packages.
• Uses AutoFac for Dependency Injection in the WebApi Controllers.
• Uses WebActivatorEx in order to bootstrap the dependency injection at DNN's application start. This library can also be used to invoke additional methods you may need at the very beginning of the DNN application life cycle.

DNN Versioning

The main verison number for the module is located in the *.dnn manifest file. Updating this version number will update the Assembly version and increment the /Install zips.

<package name="CompanyName.ModuleName" type="Module" version="1.0.0.0">

Packages

• AngularJS
  • Angular-UI
  • Angular UI-Router
• MomentJS
• LoDash
• RxJS
• AutoFac
• WebActivatorEx
• Toastr