Skip to content

Latest commit

 

History

History
388 lines (294 loc) · 18 KB

README.md

File metadata and controls

388 lines (294 loc) · 18 KB
Raw

MultiShop

Overview

This project is an e-commerce application currently being developed with ASP.NET Core. It currently includes 7 microservices: Catalog, Discount, Order, Cargo, Basket, Comment and IdentityServer. I will add more microservices in the future to make the project better and bigger.

Microservices

IdentityServer Microservice

  • Database: MS SQL Server

Packages:

Configuration (appsettings.json):

The appsettings.json file is not included in the project as it contains sensitive information. Instead, you should create your own appsettings.json file with the following structure for MultiShop.IdentityServer project:

{
  "ConnectionStrings": {
    "MSSQLServerConnection": "Server={your_server};Database={your_database};User={your_username};Password={your_password};Trusted_Connection=False;MultipleActiveResultSets=true;Encrypt=True;TrustServerCertificate=True;"
  },
  "CertificateSettings": {
    "Password": "{cert_password}"
  }
}

Note: Replace {your_server}, {your_database}, {your_username}, and {your_password} with your actual SQL Server connection details. Replace {cert_password} with your actual certificate password.

X.509 Certificate

In IdentityServer4, the AddDeveloperSigningCredential() method creates a temporary signing key for development. This is fine for local development, but in production, you need a more secure approach. Using an X.509 certificate is one option.

For production, you need to either generate or buy an X.509 certificate from a Certificate Authority (CA). But for development, you can create a self-signed certificate. Here’s how to do it using PowerShell.

Create a Self-Signed Certificate with PowerShell

  1. To generate a self-signed certificate in PowerShell, run the following commands:

    $cert = New-SelfSignedCertificate -DnsName "localhost" -CertStoreLocation "cert:\LocalMachine\My" -KeySpec KeyExchange

    -DnsName "localhost": Specifies the DNS name for the certificate. You can replace this with your domain, e.g., yourdomain.com.

  2. Create a password for the certificate:

 $certPassword = ConvertTo-SecureString -String "your_password_here" -Force -AsPlainText

This command creates a password to protect the .pfx file. Replace your_password_here with your chosen password.

  1. Export the certificate to a .pfx file:
 Export-PfxCertificate -Cert $cert -FilePath "C:\path_to_your_certificate.pfx" -Password $certPassword

Note: Run PowerShell as an administrator if you get an access denied error.

Adding the Certificate to the Project

After generating the self-signed certificate, follow these steps to integrate it into your project:

  1. Move the Certificate:

    -Move the .pfx file to the Certificates folder in the MultiShop.IdentityServer project.

  2. Update appsettings.json

    -Store the certificate password in appsettings.json:

    {
  "CertificateSettings": {
    "Password": "{cert_password}"
  }
}

  3. Update Startup.cs

    -Modify the Startup.cs file to load and use the certificate:

    namespace MultiShop.IdentityServer
{
    public class Startup
    {
        ...

        public void ConfigureServices(IServiceCollection services)
        {
            ...

            // The certificate is loaded from the "Certificates" folder in the project's root directory
            var certificatePath = Path.Combine(Directory.GetCurrentDirectory(), "Certificates", "MultiShopCertificate.pfx");
            var certificatePassword = Configuration["CertificateSettings:Password"];

            // Loading the certificate
            var certificate = new X509Certificate2(certificatePath, certificatePassword);

            ...

            // not recommended for production - you need to store your key material somewhere secure
            // builder.AddDeveloperSigningCredential();

            // Use the X.509 certificate to sign JWT tokens
            builder.AddSigningCredential(certificate);

            ...
        }
    }
}

Developer Signing Credential (For Development Only)

For the development environment, using an X.509 certificate is not mandatory. The builder.AddDeveloperSigningCredential(); method is sufficient. This method generates a temporary signing key, allowing developers to work quickly without needing a certificate. However, this is not suitable for production due to security concerns. Creating a self-signed certificate using PowerShell helps simulate a more secure signing method during development. Even though self-signed certificates may not be fully secure, they prepare us for the transition to production and help us become familiar with security concepts.

In production environments, trusted certificates are necessary to ensure that browsers and clients recognize them as secure. Therefore, before going live, obtaining a certificate from a trusted Certificate Authority (CA) is the best practice.

Catalog Microservice

  • Database: MongoDB
  • Features: Some CRUD operations for categories and products.

Packages:

Configuration (appsettings.json):

{
  "DatabaseSettings": {
    "CategoryCollectionName": "Categories",
    "ProductCollectionName": "Products",
    "ProductDetailCollectionName": "ProductDetails",
    "ProductImageCollectionName": "ProductImages",
    "FeatureSliderCollectionName": "FeatureSliders",
    "SpecialOfferCollectionName": "SpecialOffers",
    "FeatureCollectionName": "Features",
    "BrandCollectionName": "Brands",
    "AboutCollectionName": "Abouts",
    "ContactCollectionName": "Contacts",
    "ConnectionString": "your_connection_string",
    "DatabaseName": "MultiShopCatalogDb"
  },
  "IdentityServerUrl": "your_url",
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

Note: Replace your_connection_string with your MongoDB server connection string. Also, replace your_url with the correct URL of your Identity Server, such as https://localhost:5001 for a local development environment. This URL will be used for authentication and authorization.

Connection String Examples:

  • Local Server (localhost): mongodb://localhost:27017
    This is the default connection string for a MongoDB server running on your local machine.

  • Remote Server: mongodb://your_mongodb_server:27017
    Replace your_mongodb_server with the IP address or domain name of your remote MongoDB server. This example assumes the default port is used.

  • Custom Port: mongodb://your_mongodb_server:your_custom_port
    If your MongoDB server uses a port other than the default (27017), replace your_custom_port with the actual port number.

Discount Microservice

  • Database: MS SQL Server
  • Features: Some CRUD operations for coupons.

Packages:

Configuration (appsettings.json):

The appsettings.json file is not included in the project as it contains sensitive information. Instead, you should create your own appsettings.json file with the following structure for MultiShop.Discount project:

{
  "ConnectionStrings": {
    "MSSQLServerConnection": "Server=your_server_name;Database=MultiShopDiscountDb;Trusted_Connection=True;MultipleActiveResultSets=true;Encrypt=True;TrustServerCertificate=True;"
  },
  "IdentityServerUrl": "your_url",
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

Note: Replace your_server_name with your actual SQL Server instance name. Also, replace your_url with the correct URL of your Identity Server, such as https://localhost:5001 for a local development environment. This URL will be used for authentication and authorization.

Order Microservice

  • Database: MS SQL Server
  • Features: Utilizes Onion architecture, CQRS and Mediator design patterns. Includes various CRUD operations for managing orders.

Packages:

Configuration (appsettings.json):

The appsettings.json file is not included in the project as it contains sensitive information. Instead, you should create your own appsettings.json file with the following structure for MultiShop.Order.WebApi project:

{
  "ConnectionStrings": {
    "MSSQLServerConnection": "Server={your_server};Database={your_database};User={your_username};Password={your_password};Trusted_Connection=False;MultipleActiveResultSets=true;Encrypt=True;TrustServerCertificate=True;"
  },
  "IdentityServerUrl": "your_url",
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

Note: Replace {your_server}, {your_database}, {your_username}, and {your_password} with your actual SQL Server connection details. Also, replace your_url with the correct URL of your Identity Server, such as https://localhost:5001 for a local development environment. This URL will be used for authentication and authorization.

Cargo Microservice

  • Database: MS SQL Server
  • Features: Multitier architecture approach has been used for development. The repository design pattern is used to avoid repetition in CRUD operations. It includes various CRUD operations for managing cargo-related tasks.

Packages:

Configuration (appsettings.json):

The appsettings.json file is not included in the project as it contains sensitive information. Instead, you should create your own appsettings.json file with the following structure for MultiShop.Cargo.WebApi project:

{
  "ConnectionStrings": {
    "MSSQLServerConnection": "Server={your_server};Database={your_database};User={your_username};Password={your_password};Trusted_Connection=False;MultipleActiveResultSets=true;Encrypt=True;TrustServerCertificate=True;"
  },
  "IdentityServerUrl": "your_url",
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

Note: Replace {your_server}, {your_database}, {your_username}, and {your_password} with your actual SQL Server connection details. Also, replace your_url with the correct URL of your Identity Server, such as https://localhost:5001 for a local development environment. This URL will be used for authentication and authorization.

Basket Microservice

  • Storage: Redis
  • Features: It allows users to store, retrieve, and delete their baskets in the Redis database based on their authenticated user ID.

Packages:

Redis Setup

In this project, Redis is required. You can easily set up a Redis container using Docker and Portainer. Follow these steps:

  1. Open Portainer and navigate to the Templates section.
  2. Select the Redis template and configure it as needed.
  3. Deploy the Redis container.

Make sure to update your appsettings.json file with the correct Redis host and port details (default port: 6379).

Configuration (appsettings.json):

The appsettings.json file is not included in the project as it contains sensitive information. Instead, you should create your own appsettings.json file with the following structure for MultiShop.Basket project:

{
  "RedisSettings": {
    "Host": "localhost",
    "Port": "your_port"
  },
  "IdentityServerUrl": "your_url",
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

Note: Adjust the Host and Port fields under RedisSettings according to your Redis server configuration. Also, replace your_url with the correct URL of your Identity Server, such as https://localhost:5001 for a local development environment. This URL will be used for authentication and authorization.

Comment Microservice

  • Database: MS SQL Server
  • Features: Some CRUD operations for user comments.

Packages:

Configuration (appsettings.json):

The appsettings.json file is not included in the project as it contains sensitive information. Instead, you should create your own appsettings.json file with the following structure for MultiShop.Comment project:

{
  "ConnectionStrings": {
    "MSSQLServerConnection": "Server={your_server};Database={your_database};User={your_username};Password={your_password};Trusted_Connection=False;MultipleActiveResultSets=true;Encrypt=True;TrustServerCertificate=True;"
  },
  "IdentityServerUrl": "your_url",
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

Note: Replace {your_server}, {your_database}, {your_username}, and {your_password} with your actual SQL Server connection details. Also, replace your_url with the correct URL of your Identity Server, such as https://localhost:5001 for a local development environment. This URL will be used for authentication and authorization.