The premium source package

Create the project

1. In Visual Studio, open the Create a new project dialog.

2. Choose the programming language as CSharp and ASP.NET Core Empty as the template.

3. Provide the project name and other information.

4. Choose the target framework as ‘.NET Core 3.1’ and click on the Create button.

Install the ASPSecurityKit library package

As part of this step, we’ll install the ASPSecurityKit.NetCore NuGet package, which provides full ASPSecurityKit capabilities to build secure and reliable modern MVC web applications on ASP.NET Core. Check out the comprehensive security pipeline article to understand the multi-stage identity and access verification workflow ASPSecurityKit provides.

1. Open Package Manager (PM) Console and make sure that the selected project is the web application project just created.

2. Type the following command and hit enter:

install-package ASPSecurityKit.NetCore

install-package ASPSecurityKit.NetFramework.Mvc

3. Make sure that the package installs successfully

You can also use the Package Manager UI to install the above package.

Install the source package into the project

As part of this step, we’ll install the Premium-ASP.NET Core Mvc source package.

Follow these steps to install a source package. On the ‘Install a Source Package’ screen, make sure you select NetCoreMvc as the platform (NetFrameworkMvc if you’re building on the .NET Framework instead) and Premium as the source package. If the package doesn’t appear, it means you haven’t bought it. You can click on Show all checkbox and then click on the Buy button to purchase this package.

Upon successful installation, you should see several new items added to the project.

Next, make sure you also install the node dependencies. The Premium ASP.NET Core Mvc source package we’ve just installed have some script dependencies such as bootstrap, jquery, jtable, etc. which have been configured as NPM dependencies. (Not applicable for .NET Framework)

Generate license key for the project

You cannot perform subsequent steps without generating a license key for this project because the number of operations permitted for trial has been exceeded by the source code you’ve obtained from the Premium-ASP.NET Core Mvc source package.

Follow these steps to generate a license key. On the ‘Generate License Key’ screen, make sure you select NetCoreMvc as the platform (NetFrameworkMvc if you’re building on the .NET Framework instead). If no subscription appears, it means you either haven’t bought one or have consumed it already. You can click on ‘Buy More’ to open the Dashboard to purchase a new subscription.

The premium-ASP.NET Core Mvc source package comes with a logic that makes call to License.TryRegisterFromExecutionPath which instructs ASPSecurityKit to automatically locate and register the license key from file.

Create the database

The Premium-ASP.NET Core Mvc source package we had installed in a prior step, comes with EF migrations and T-SQL scripts, so you can create the database backing the models of your new project immediately.

1. Verify the connectionString: Open appsettings.json file from Solution Explorer and verify that the DefaultConnection has a valid connectionString as per SQL Server version available on your machine. If it’s not, make the appropriate changes.

2. Open Package Manager Console and make sure that the selected project is the web application project we’ve been working with in this walkthrough.

3. Type the following command and hit enter:

update-database

4. If you receive an error stating something like:

   • “The term update-database is not recognized as the name of a cmdlet, function, script file, or operable program.”, you should close and restart Visual Studio, and open the same solution. For more information about this issue, check out the troubleshooting section.

   • “This Evaluation license has a quota of … operations for NetCore feature which has been exceeded.”, you likely don’t have the license key generated, and the trial limitations have been exceeded. For more information about this issue, check out the troubleshooting section.

5. Make sure that the database is created successfully.

   • You will see messages something like “Applying migration …”. If all goes well, the last message that you see is “Done” (with EF Core; with EF framework, it’s “Running seed method”).

Application Configuration

The Premium-ASP.NET Core MVC source package has also come up with some useful configuration settings that the accompanying components make use of. You can have a look at them in the ‘app’ section of the appsettings.json file in the project root.

By default, most are populated with the default value or values you provided on the second step of the ‘Install a Source Package’ screen. The following settings related to email component aren’t populated by default and are required for email verification and forgot password flows to work:

"app": {
    ....
    "MailId": "[email protected]",
    "MailPassword": "password",
    "MailProvider": "Gmail",
    // "MailHost": "",
    // "MailPort": "",
    // "MailUseSSL": "",
    // "MailFrom": "",
    ....
},

The above settings are used by the Mailer component installed as Infrastructure\Mailer.cs in your project. MailId and MailPassword settings represent the SMTP credentials.

MailProvider setting can take one of six values: MailGun, SendGrid, Gmail, Outlook, Yahoo and Custom.

Additionally, you can use a setting MailFrom to specify the ‘from address’ if it’s different from the MailId (the username). This is usually true when you’re using a service like MailGun or SendGrid.

With Custom provider you need to at least specify the MailHost which should be the SMTP server host name. Custom lets you configure services like Amazon SES to send emails.

As you get the source with the Premium package, you can further extend the Mailer component if you want any further customization.

Try it out

Press F5/ctrl+F5 to run the application. You can sign in using the [super admin] credentials – username as in the settings and the default password ‘admin’. You can also sign up and try out flows like email verification and account settings.

Congratulations for installing ASPSecurityKit! You are going to absolutely love the secure, flexible and rapid development basis it provides for your project!

Create the project

1. In Visual Studio, open the Create a new project dialog.

2. Choose the programming language as CSharp and ASP.NET Core Empty as the template.

3. Provide the project name and other information.

4. Choose the target framework as ‘.NET Core 3.1’ and click on the Create button.

Install the ASPSecurityKit library package

As part of this step, we’ll install the ASPSecurityKit.ServiceStack NuGet package, which provides full ASPSecurityKit capabilities to build secure and reliable API platform/sservices on ServiceStack (for both .NET Core and .NET Framework). Check out the comprehensive security pipeline article to understand the multi-stage identity and access verification workflow ASPSecurityKit provides.

1. Open Package Manager (PM) Console and make sure that the selected project is the web application project just created.

2. Type the following command and hit enter:

install-package ASPSecurityKit.ServiceStack

3. Make sure that the package installs successfully

You can also use the Package Manager UI to install the above package.

Install the source package into the project

As part of this step, we’ll install the Premium-ServiceStack .NET Core source package.

Follow these steps to install a source package. On the ‘Install a Source Package’ screen, make sure you select NetCoreServiceStack as the platform (NetFrameworkServiceStack if you’re building on the .NET Framework instead) and Premium as the source package. If the package doesn’t appear, it means you haven’t bought it. You can click on Show all checkbox and then click on the Buy button to purchase this package.

Upon successful installation, you should see several new items added to the project.

Generate license key for the project

You cannot perform subsequent steps without generating a license key for this project because the number of operations permitted for trial has been exceeded by the source code you’ve obtained from the Premium-ServiceStack .NET Core source package.

Follow these steps to generate a license key. On the ‘Generate License Key’ screen, make sure you select NetCoreApi as the platform (NetFrameworkServiceStack if you’re building on the .NET Framework instead). If no subscription appears, it means you either haven’t bought one or have consumed it already. You can click on ‘Buy More’ to open the Dashboard to purchase a new subscription.

The Premium-ServiceStack .NET Core source package comes with a logic that makes call to License.TryRegisterFromExecutionPath which instructs ASPSecurityKit to automatically locate and register the license key from file.

Create the database

The Premium-ServiceStack .NET Core source package we had installed in a prior step, comes with EF migrations and T-SQL scripts, so you can create the database backing the models of your new project immediately.

1. Verify the connectionString: Open appsettings.json file from Solution Explorer and verify that the DefaultConnection has a valid connectionString as per SQL Server version available on your machine. If it’s not, make the appropriate changes.

2. Open Package Manager Console and make sure that the selected project is the web application project we’ve been working with in this walkthrough.

3. Type the following command and hit enter:

update-database

4. If you receive an error stating something like:

   • “The term update-database is not recognized as the name of a cmdlet, function, script file, or operable program.”, you should close and restart Visual Studio, and open the same solution. For more information about this issue, check out the troubleshooting section.

   • “This Evaluation license has a quota of … operations for NetCore feature which has been exceeded.”, you likely don’t have the license key generated, and the trial limitations have been exceeded. For more information about this issue, check out the troubleshooting section.

5. Make sure that the database is created successfully.

   • You will see messages something like “Applying migration …”. If all goes well, the last message that you see is “Done” (with EF Core; with EF framework, it’s “Running seed method”).

Application Configuration

The Premium-ServiceStack .NET Core source package has also come up with some useful configuration settings that the accompanying components make use of. You can have a look at them in the ‘app’ section of the appsettings.json file in the project root.

By default, most are populated with the default value or values you provided on the second step of the ‘Install a Source Package’ screen. The following settings related to email component aren’t populated by default and are required for email verification and forgot password flows to work:

"app": {
    ....
    "MailId": "[email protected]",
    "MailPassword": "password",
    "MailProvider": "Gmail",
    // "MailHost": "",
    // "MailPort": "",
    // "MailUseSSL": "",
    // "MailFrom": "",
    ....
},

The above settings are used by the Mailer component installed as Infrastructure\Mailer.cs in your project. MailId and MailPassword settings represent the SMTP credentials.

MailProvider setting can take one of six values: MailGun, SendGrid, Gmail, Outlook, Yahoo and Custom.

Additionally, you can use a setting MailFrom to specify the ‘from address’ if it’s different from the MailId (the username). This is usually true when you’re using a service like MailGun or SendGrid.

With Custom provider you need to at least specify the MailHost which should be the SMTP server host name. Custom lets you configure services like Amazon SES to send emails.

As you get the source with the Premium package, you can further extend the Mailer component if you want any further customization.

Try it out

Press F5/ctrl+F5 to run the application. You can sign in using the [super admin] credentials – username as in the settings and the default password ‘admin’. You can also sign up and try out flows like email verification and account settings.

Congratulations for installing ASPSecurityKit! You are going to absolutely love the secure, flexible and rapid development basis it provides for your project!