How To Contribute

Setup

Create a new project for your module. Use “ASP.NET Core Web Application” project template (or “Telerik ASP.NET Core MVC Application” project template if you are using Kendo UI controls) so you have the basic structure created for you. Name the project “Synapse.UI.Modules.[your module name]”.

To register additional services to the service collection, implement the IAddModuleService interface. The interface is defined inside Synapse.UI.Infrastructure so you’ll need to add a reference to it in your project. Below is an example of the implementation.

Running The App

Build your project as you would normally do.

In Synapse.UI.WebApplication project,

Create a folder under the Modules folder. Copy your class library and any other dependent libraries to this folder. Libraries that are already referenced in Synapse.UI.WebApplication project can be excluded.

Edit appsettings.json. Add another entry under the Include section. Place it in the order of how you would like it appear on the navigation menu. Change the value of SynapseControllerAPIURL accordingly. Below is an example of the configuration settings.