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.

66 lines
3.2 KiB

  1. # Shentun.WebPeis
  2. ## About this solution
  3. 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.
  4. ### Pre-requirements
  5. * [.NET 8.0+ SDK](https://dotnet.microsoft.com/download/dotnet)
  6. * [Node v18 or 20](https://nodejs.org/en)
  7. ### Configurations
  8. 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:
  9. ### Before running the application
  10. #### Generating a Signing Certificate
  11. 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.
  12. 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:
  13. ```bash
  14. dotnet dev-certs https -v -ep openiddict.pfx -p 7ff5039e-a32c-4134-8ec4-edaba46728b1
  15. ```
  16. > `7ff5039e-a32c-4134-8ec4-edaba46728b1` is the password of the certificate, you can change it to any password you want.
  17. It is recommended to use **two** RSA certificates, distinct from the certificate(s) used for HTTPS: one for encryption, one for signing.
  18. For more information, please refer to: https://documentation.openiddict.com/configuration/encryption-and-signing-credentials.html#registering-a-certificate-recommended-for-production-ready-scenarios
  19. > Also, see the [Configuring OpenIddict](https://docs.abp.io/en/abp/latest/Deployment/Configuring-OpenIddict#production-environment) documentation for more information.
  20. #### Install Client-Side Libraries
  21. Run the following command in the directory of your final application:
  22. ```bash
  23. abp install-libs
  24. ```
  25. > 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.
  26. #### Create the Database
  27. Run `Shentun.WebPeis.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.
  28. ### Solution structure
  29. This is a layered monolith application that consists of the following applications:
  30. * `Shentun.WebPeis.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.
  31. ### Deploying the application
  32. 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.
  33. ### Additional resources
  34. You can see the following resources to learn more about your solution and the ABP Framework:
  35. * [Web Application Development Tutorial](https://docs.abp.io/en/abp/latest/Tutorials/Part-1)
  36. * [Application Startup Template Structure](https://docs.abp.io/en/abp/latest/Startup-Templates/Application)