You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
abp/templates/app/aspnet-core/README.md

5.4 KiB

MyCompanyName.MyProjectName

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 `MyCompanyName.MyProjectName.AuthServer`, `MyCompanyName.MyProjectName.HttpApi.Host` and `MyCompanyName.MyProjectName.DbMigrator` projects and change it if you need. * Check the `ConnectionStrings` in `appsettings.json` files under the `MyCompanyName.MyProjectName.Web` and `MyCompanyName.MyProjectName.DbMigrator` projects and change it if you need. * Check the `ConnectionStrings` in `appsettings.json` files under the `MyCompanyName.MyProjectName.Blazor` and `MyCompanyName.MyProjectName.DbMigrator` projects and change it if you need. * Check the `ConnectionStrings` in `appsettings.json` files under the `MyCompanyName.MyProjectName.HttpApi.Host` and `MyCompanyName.MyProjectName.DbMigrator` projects and change it if you need. * Check the `ConnectionStrings` in `appsettings.json` files under the `MyCompanyName.MyProjectName.HttpApi.Host` and `MyCompanyName.MyProjectName.DbMigrator` projects and change it if you need.

Preparings for the first run

  • Run abp install-libs command on your solution folder to install client-side package dependencies. This step is automatically done when you create a new solution with ABP CLI. However, you should run it yourself if you have first cloned this solution from your source control, or added a new client-side package dependency to your solution.
  • Run MyCompanyName.MyProjectName.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:

  • MyCompanyName.MyProjectName.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.
  • MyCompanyName.MyProjectName.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.
  • MyCompanyName.MyProjectName.HttpApi.Host: ASP.NET Core API application that is used to expose the APIs to the clients.
  • MyCompanyName.MyProjectName.Web: ASP.NET Core MVC / Razor Pages application that is the essential web application of the solution.
  • MyCompanyName.MyProjectName.Blazor: ASP.NET Core Blazor Server application that is the essential web application of the solution.
  • MyCompanyName.MyProjectName.Blazor: ASP.NET Core Blazor WASM application that is a single page application that runs on the browser.
  • angular: Angular application.
  • MyCompanyName.MyProjectName.Web: ASP.NET Core MVC / Razor Pages application that is the essential web application of the solution.
  • MyCompanyName.MyProjectName.Blazor: ASP.NET Core Blazor Server application that is the essential web application of the solution.
  • MyCompanyName.MyProjectName.HttpApi.Host: ASP.NET Core API application that is used to expose the APIs to the clients.
  • MyCompanyName.MyProjectName.Blazor: ASP.NET Core Blazor Server application that is the essential web application of the solution.
  • MyCompanyName.MyProjectName.HttpApi.Host: ASP.NET Core API application that is used to expose the APIs to the clients.
  • angular: Angular application.

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: