diff --git a/templates/app-nolayers/aspnet-core/README.md b/templates/app-nolayers/aspnet-core/README.md index c0b1a5e76d..7327f81f55 100644 --- a/templates/app-nolayers/aspnet-core/README.md +++ b/templates/app-nolayers/aspnet-core/README.md @@ -1,12 +1,23 @@ # MyCompanyName.MyProjectName -## About This Solution +## About this solution -This is a minimalist, non-layered startup solution with the ABP Framework. All the fundamental ABP modules are already installed. +This is a minimalist, non-layered startup solution with the ABP Framework. All the fundamental ABP modules are already installed. -## Before Running the Solution +### Pre-requirements -### Generating a Signing Certificate +* [.NET 7.0+ SDK](https://dotnet.microsoft.com/download/dotnet) +* [Node v18 or 20](https://nodejs.org/en) + +### 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` project 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. @@ -24,7 +35,7 @@ For more information, please refer to: https://documentation.openiddict.com/conf > Also, see the [Configuring OpenIddict](https://docs.abp.io/en/abp/latest/Deployment/Configuring-OpenIddict#production-environment) documentation for more information. -### Install Client-Side Libraries +#### Install Client-Side Libraries Run the following command in the directory of your final application: @@ -34,7 +45,7 @@ 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. -## How to Run +### How to Run The application needs to connect to a database. Run the following command in the `MyCompanyName.MyProjectName` directory to migrate the database and seed the initial data: @@ -44,6 +55,44 @@ dotnet run --migrate-database This command will create and seed the initial database. Then you can run the application with any IDE that supports .NET. -## Deploying the 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](https://docs.abp.io/en/abp/latest/Deployment/Index) before deploying your application. + +### Additional resources + +You can see the following resources to learn more about your solution and the ABP Framework: + +* [Application (Single Layer) Startup Template](https://docs.abp.io/en/abp/latest/Startup-Templates/Application-Single-Layer) + + +* [ASP.NET Core MVC / Razor Pages: The Basic Theme](https://docs.abp.io/en/abp/latest/UI/AspNetCore/Basic-Theme) + + +* [LeptonX Lite MVC UI](https://docs.abp.io/en/abp/latest/Themes/LeptonXLite/AspNetCore) + + + + +* [Blazor UI: Basic Theme](https://docs.abp.io/en/abp/latest/UI/Blazor/Basic-Theme?UI=BlazorServer) + + +* [LeptonX Lite Blazor UI](https://docs.abp.io/en/abp/latest/Themes/LeptonXLite/Blazor?UI=BlazorServer) + + + + +* [Blazor UI: Basic Theme](https://docs.abp.io/en/abp/latest/UI/Blazor/Basic-Theme?UI=Blazor) + + +* [LeptonX Lite Blazor UI](https://docs.abp.io/en/abp/latest/Themes/LeptonXLite/Blazor?UI=Blazor) + + + + +* [Angular UI: Basic Theme](https://docs.abp.io/en/abp/latest/UI/Angular/Basic-Theme) + + +* [LeptonX Lite Angular UI](https://docs.abp.io/en/abp/latest/Themes/LeptonXLite/Angular) + + diff --git a/templates/app/aspnet-core/README.md b/templates/app/aspnet-core/README.md index 680579f70b..0a25f683d2 100644 --- a/templates/app/aspnet-core/README.md +++ b/templates/app/aspnet-core/README.md @@ -1,12 +1,42 @@ # MyCompanyName.MyProjectName -## About This Solution +## About this solution -This is a layered startup solution based on [Domain Driven Design (DDD)](https://docs.abp.io/en/abp/latest/Domain-Driven-Design) practises. All the fundamental ABP modules are already installed. Check the [Application Startup Template](https://docs.abp.io/en/abp/latest/Startup-Templates/Application) documentation for more info. +This is a layered startup solution based on [Domain Driven Design (DDD)](https://docs.abp.io/en/abp/latest/Domain-Driven-Design) practises. All the fundamental ABP modules are already installed. -## Before Running the Solution +### Pre-requirements -### Generating a Signing Certificate +* [.NET 7.0+ SDK](https://dotnet.microsoft.com/download/dotnet) +* [Node v18 or 20](https://nodejs.org/en) + +* [Redis](https://redis.io/) + + +### 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. + + + +### 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. @@ -24,7 +54,7 @@ For more information, please refer to: https://documentation.openiddict.com/conf > Also, see the [Configuring OpenIddict](https://docs.abp.io/en/abp/latest/Deployment/Configuring-OpenIddict#production-environment) documentation for more information. -### Install Client-Side Libraries +#### Install Client-Side Libraries Run the following command in the directory of your final application: @@ -34,6 +64,90 @@ 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. -## 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](https://docs.abp.io/en/abp/latest/Deployment/Index) before deploying your application. \ No newline at end of file +### 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](https://docs.abp.io/en/abp/latest/Deployment/Index) before deploying your application. + +* 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](https://docs.abp.io/en/abp/latest/Deployment/Index) before deploying your application. + +### Additional resources + +You can see the following resources to learn more about your solution and the ABP Framework: + +* [Web Application Development Tutorial](https://docs.abp.io/en/abp/latest/Tutorials/Part-1) +* [Application Startup Template Structure](https://docs.abp.io/en/abp/latest/Startup-Templates/Application) + + +* [ASP.NET Core MVC / Razor Pages: The Basic Theme](https://docs.abp.io/en/abp/latest/UI/AspNetCore/Basic-Theme) + + +* [LeptonX Lite MVC UI](https://docs.abp.io/en/abp/latest/Themes/LeptonXLite/AspNetCore) + + + + +* [Blazor UI: Basic Theme](https://docs.abp.io/en/abp/latest/UI/Blazor/Basic-Theme?UI=BlazorServer) + + +* [LeptonX Lite Blazor UI](https://docs.abp.io/en/abp/latest/Themes/LeptonXLite/Blazor?UI=BlazorServer) + + + + +* [Blazor UI: Basic Theme](https://docs.abp.io/en/abp/latest/UI/Blazor/Basic-Theme?UI=Blazor) + + +* [LeptonX Lite Blazor UI](https://docs.abp.io/en/abp/latest/Themes/LeptonXLite/Blazor?UI=Blazor) + + + + +* [Angular UI: Basic Theme](https://docs.abp.io/en/abp/latest/UI/Angular/Basic-Theme) + + +* [LeptonX Lite Angular UI](https://docs.abp.io/en/abp/latest/Themes/LeptonXLite/Angular) + +