Skip to content

Latest commit

 

History

History
70 lines (40 loc) · 3.78 KB

README.md

File metadata and controls

70 lines (40 loc) · 3.78 KB
Raw

AbpOrleansAppTemplate

About this solution

This is a layered startup solution based on Domain Driven Design (DDD) practises. All the fundamental ABP modules are already installed.

Pre-requirements

Configurations

The solution comes with a default configuration that works out of the box. However, you may consider to change the following configuration before running your solution:

  • Check the ConnectionStrings in appsettings.json files under the AbpOrleansAppTemplate.AuthServer, AbpOrleansAppTemplate.HttpApi.Host and AbpOrleansAppTemplate.DbMigrator projects and change it if you need.

Before running the application

Generating a Signing Certificate

In the production environment, you need to use a production signing certificate. ABP Framework sets up signing and encryption certificates in your application and expects an openiddict.pfx file in your application.

This certificate is already generated by ABP CLI, so most of the time you don't need to generate it yourself. However, if you need to generate a certificate, you can use the following command:

dotnet dev-certs https -v -ep openiddict.pfx -p 990667ad-2b05-406a-87f8-d0e1648cc0f4

990667ad-2b05-406a-87f8-d0e1648cc0f4 is the password of the certificate, you can change it to any password you want.

It is recommended to use two RSA certificates, distinct from the certificate(s) used for HTTPS: one for encryption, one for signing.

For more information, please refer to: https://documentation.openiddict.com/configuration/encryption-and-signing-credentials.html#registering-a-certificate-recommended-for-production-ready-scenarios

Also, see the Configuring OpenIddict documentation for more information.

Install Client-Side Libraries

Run the following command in the directory of your final application:

abp install-libs

This command installs all NPM packages for MVC/Razor Pages and Blazor Server UIs and this command is already run by the ABP CLI, so most of the time you don't need to run this command manually.

Create the Database

Run AbpOrleansAppTemplate.DbMigrator to create the initial database. This should be done in the first run. It is also needed if a new database migration is added to the solution later.

Solution structure

This is a layered monolith application that consists of the following applications:

  • AbpOrleansAppTemplate.DbMigrator: A console application which applies the migrations and also seeds the initial data. It is useful on development as well as on production environment.
  • AbpOrleansAppTemplate.AuthServer: ASP.NET Core MVC / Razor Pages application that is integrated OAuth 2.0(OpenIddict) and account modules. It is used to authenticate users and issue tokens.
  • AbpOrleansAppTemplate.HttpApi.Host: ASP.NET Core API application that is used to expose the APIs to the clients.

Deploying the application

Deploying an ABP application is not different than deploying any .NET or ASP.NET Core application. However, there are some topics that you should care about when you are deploying your applications. You can check ABP's Deployment documentation before deploying your application.

Additional resources

You can see the following resources to learn more about your solution and the ABP Framework: