From 3de924b2d2801f572f288e802acf905b0abc1cbd Mon Sep 17 00:00:00 2001 From: Engincan VESKE <43685404+EngincanV@users.noreply.github.com> Date: Thu, 28 Sep 2023 09:26:21 +0300 Subject: [PATCH 1/3] Create README.md file for application templates and mention running and deploying --- templates/app-nolayers/aspnet-core/README.md | 41 ++++++++++++++++---- templates/app/aspnet-core/README.md | 35 +++++++++++++++++ 2 files changed, 69 insertions(+), 7 deletions(-) create mode 100644 templates/app/aspnet-core/README.md diff --git a/templates/app-nolayers/aspnet-core/README.md b/templates/app-nolayers/aspnet-core/README.md index 9e142b3119..5da147b18e 100644 --- a/templates/app-nolayers/aspnet-core/README.md +++ b/templates/app-nolayers/aspnet-core/README.md @@ -1,18 +1,45 @@ -## About this solution +# MyCompanyName.MyProjectName + +## About This Solution This is a minimalist, non-layered startup solution with the ABP Framework. All the fundamental ABP modules are already installed. -## How to run +## Before Running the Solution + +### 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: + +```bash +dotnet dev-certs https -v -ep openiddict.pfx -p 00000000-0000-0000-0000-000000000000 +``` + +> `00000000-0000-0000-0000-000000000000` is the password of the certificate, you can change it to any password you want. + +> See the [Configuring OpenIddict](https://docs.abp.io/en/abp/latest/Deployment/Configuring-OpenIddict#production-environment) documentation for more information. -The application needs to connect to a database. Run the following command in the `MyCompanyName.MyProjectName` directory: +### Install Client-Side Libraries + +Run the following command in the directory of your final application: + +```bash +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 + +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: ````bash dotnet run --migrate-database ```` -This will create and seed the initial database. Then you can run the application with any IDE that supports .NET. - -Happy coding..! - +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 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. diff --git a/templates/app/aspnet-core/README.md b/templates/app/aspnet-core/README.md new file mode 100644 index 0000000000..c090443a73 --- /dev/null +++ b/templates/app/aspnet-core/README.md @@ -0,0 +1,35 @@ +# MyCompanyName.MyProjectName + +## 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. + +## Before Running the Solution + +### 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: + +```bash +dotnet dev-certs https -v -ep openiddict.pfx -p 00000000-0000-0000-0000-000000000000 +``` + +> `00000000-0000-0000-0000-000000000000` is the password of the certificate, you can change it to any password you want. + +> See the [Configuring OpenIddict](https://docs.abp.io/en/abp/latest/Deployment/Configuring-OpenIddict#production-environment) documentation for more information. + +### Install Client-Side Libraries + +Run the following command in the directory of your final application: + +```bash +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 From 55ec63c7ff8577ca9bd6b5c3899354f4f8459fca Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Fri, 29 Sep 2023 09:39:31 +0300 Subject: [PATCH 2/3] Update README.md files in templates --- templates/app-nolayers/aspnet-core/README.md | 4 ++++ templates/app/aspnet-core/README.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/templates/app-nolayers/aspnet-core/README.md b/templates/app-nolayers/aspnet-core/README.md index 5da147b18e..87dd910b9c 100644 --- a/templates/app-nolayers/aspnet-core/README.md +++ b/templates/app-nolayers/aspnet-core/README.md @@ -18,6 +18,10 @@ dotnet dev-certs https -v -ep openiddict.pfx -p 00000000-0000-0000-0000-00000000 > `00000000-0000-0000-0000-000000000000` 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 + > See the [Configuring OpenIddict](https://docs.abp.io/en/abp/latest/Deployment/Configuring-OpenIddict#production-environment) documentation for more information. ### Install Client-Side Libraries diff --git a/templates/app/aspnet-core/README.md b/templates/app/aspnet-core/README.md index c090443a73..f97998f0b8 100644 --- a/templates/app/aspnet-core/README.md +++ b/templates/app/aspnet-core/README.md @@ -18,6 +18,10 @@ dotnet dev-certs https -v -ep openiddict.pfx -p 00000000-0000-0000-0000-00000000 > `00000000-0000-0000-0000-000000000000` 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 + > See the [Configuring OpenIddict](https://docs.abp.io/en/abp/latest/Deployment/Configuring-OpenIddict#production-environment) documentation for more information. ### Install Client-Side Libraries From 95c539548f8e6bdd683851f5efa27917e3ae92da Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Fri, 29 Sep 2023 09:43:03 +0300 Subject: [PATCH 3/3] Update README.md files for app&nolayers templates --- templates/app-nolayers/aspnet-core/README.md | 4 ++-- templates/app/aspnet-core/README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/templates/app-nolayers/aspnet-core/README.md b/templates/app-nolayers/aspnet-core/README.md index 87dd910b9c..c0b1a5e76d 100644 --- a/templates/app-nolayers/aspnet-core/README.md +++ b/templates/app-nolayers/aspnet-core/README.md @@ -18,11 +18,11 @@ dotnet dev-certs https -v -ep openiddict.pfx -p 00000000-0000-0000-0000-00000000 > `00000000-0000-0000-0000-000000000000` 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. +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 -> See the [Configuring OpenIddict](https://docs.abp.io/en/abp/latest/Deployment/Configuring-OpenIddict#production-environment) documentation for more information. +> 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 diff --git a/templates/app/aspnet-core/README.md b/templates/app/aspnet-core/README.md index f97998f0b8..680579f70b 100644 --- a/templates/app/aspnet-core/README.md +++ b/templates/app/aspnet-core/README.md @@ -18,11 +18,11 @@ dotnet dev-certs https -v -ep openiddict.pfx -p 00000000-0000-0000-0000-00000000 > `00000000-0000-0000-0000-000000000000` 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. +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 -> See the [Configuring OpenIddict](https://docs.abp.io/en/abp/latest/Deployment/Configuring-OpenIddict#production-environment) documentation for more information. +> 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