Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Jackwio/SharingModule

Repository files navigation

SharingModule

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:

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.

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:

dotnet dev-certs https -v -ep openiddict.pfx -p aeca9885-8365-4928-bfed-88358eb83c23

aeca9885-8365-4928-bfed-88358eb83c23 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.

Install Client-Side Libraries

Run the following command in the directory of your final application:

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.

Create the Database

Run SharingModule.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:

  • SharingModule.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.

API Documentation

The SharingModule provides a RESTful API for managing share links. Complete API documentation is available:

  • API Documentation - Comprehensive guide for frontend/backend integration
  • OpenAPI Specification - OpenAPI 3.0 specification file for API integration
  • Swagger UI - Interactive API documentation available at https://localhost:44369/swagger when running the application

The API specification includes:

  • All available endpoints and their parameters
  • Request/response schemas
  • Authentication requirements
  • Base URL configuration
  • Example requests

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:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages