AElf.Playground

About this solution

This is a layered startup solution based on Domain Driven Design (DDD) practises. All the fundamental ABP modules are already installed. Check the Application Startup Template documentation for more info.

Pre-requirements

• .NET8.0+ SDK
• Node v18 or 20

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:

**

Before running the application

• Inside the src/AElf.Playground.HttpApi.Host directory, set dotnet user-secrets set "Aws:AccessKeyId" "access-key" to set the AWS access key.
• Inside the src/AElf.Playground.HttpApi.Host directory, set dotnet user-secrets set "Aws:SecretAccessKey" "secret-key" to set the AWS secret key.
• 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, if you didn't especially disabled it. 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 AElf.Playground.DbMigrator to create the initial database. This step is also automatically done when you create a new solution, if you didn't especially disabled it. This should be done in the first run. It is also needed if a new database migration is added to the solution later.

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.

To generate a signing certificate, you can use the following command:

dotnet dev-certs https -v -ep openiddict.pfx -p c88457d0-e03e-4ecc-81be-ee9735491949

c88457d0-e03e-4ecc-81be-ee9735491949 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.

Solution structure

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

• AElf.Playground.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.

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 and ABP Commercial'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:

• Web Application Development Tutorial
• Application Startup Template