Skip to content

Xamariners/Safeware.Saba.Ng

Repository files navigation

Safeware.Saba.Ng

About this solution

This is a minimalist, non-layered startup solution with the ABP Framework. All the fundamental ABP modules are already installed.

Pre-requirements

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 when you created the solution, 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 9bd33afa-3ea6-404f-8d94-7bc80d742857

9bd33afa-3ea6-404f-8d94-7bc80d742857 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. 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.

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 a database. Run the following command in the Safeware.Saba.Ng directory to migrate the database and seed the initial data. This step is automatically done when you create a new solution, if you didn't especially disabled it.

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.

Happy coding..!

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.

How to deploy on Docker

The application provides the related Dockerfiles and docker-compose file with scripts. You can build the docker images and run them using docker-compose. The necessary database, DbMigrator, and the application will be running on docker with health checks in an isolated docker network.

Creating the Docker images

Navigate to etc/build folder and run the build-images-locally.ps1 script. You can examine the script to set image tag for your images. It is latest by default.

Running the Docker images using Docker-Compose

Navigate to etc/docker folder and run the run-docker.ps1 script. The script will generate developer certificates (if it doesn't exist already) with dotnet dev-certs command to use HTTPS. Then, the script runs the provided docker-compose file on detached mode.

Not: Developer certificate is only valid for localhost domain. If you want to deploy to a real DNS in a production environment, use LetsEncrypt or similar tools.

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