:warning: Warning

The code samples contain multiple ways and patterns to do things and not always be considered best practices or recommended for all situations.

Database Centric vs Domain Centric Architecture

(open on draw.io)

Hexagonal Architecture

(open on draw.io)

Onion Architecture

(open on draw.io)

The Clean Architecture

(open on draw.io)

Classic Three-layer Architecture

(open on draw.io)

Modern Four-layer Architecture

(open on draw.io)

Layer Dependencies

(open on draw.io)

Layer Examples

(open on draw.io)

Testing Pyramid

(open on draw.io)

Vertical Slice Architecture (Modular Monolith)

(open on draw.io)

Solution Structure

How to Run:

Update Configuration

<details> <summary><b>Additional Configuration Sources</b></summary>

• Open ClassifiedAds.WebMVC/appsettings.json and jump to ConfigurationSources section.

  "ConfigurationSources": {
    "SqlServer": {
      "IsEnabled": false,
      "ConnectionString": "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#",
      "SqlQuery": "select [Key], [Value] from ConfigurationEntries"
    },
    "AzureKeyVault": {
      "IsEnabled": false,
      "VaultName": "https://xxx.vault.azure.net/"
    }
  },
  

• Get from Sql Server database:

  "ConfigurationSources": {
    "SqlServer": {
      "IsEnabled": true,
      "ConnectionString": "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#",
      "SqlQuery": "select [Key], [Value] from ConfigurationEntries"
    },
  },
  

• Get from Azure Key Vault:

  "ConfigurationSources": {
    "AzureKeyVault": {
      "IsEnabled": true,
      "VaultName": "https://xxx.vault.azure.net/"
    }
  },
  

• Use Both:

  "ConfigurationSources": {
    "SqlServer": {
      "IsEnabled": true,
      "ConnectionString": "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#",
      "SqlQuery": "select [Key], [Value] from ConfigurationEntries"
    },
    "AzureKeyVault": {
      "IsEnabled": true,
      "VaultName": "https://xxx.vault.azure.net/"
    }
  },
  

</details> <details> <summary><b>Storage</b></summary>

• Open ClassifiedAds.WebMVC/appsettings.json, ClassifiedAds.WebAPI/appsettings.json and jump to Storage section.

  "Storage": {
    "Provider": "Local",
  },
  

• Use Local Files:

  "Storage": {
    "Provider": "Local",
    "Local": {
      "Path": "E:\\files"
    },
  },
  

• Use Azure Blob:

  "Storage": {
    "Provider": "Azure",
    "Azure": {
      "ConnectionString": "xxx",
      "Container": "classifiedadds"
    },
  },
  

• Use Amazon S3:

  "Storage": {
    "Provider": "Amazon",
    "Amazon": {
      "AccessKeyID": "xxx",
      "SecretAccessKey": "xxx",
      "BucketName": "classifiedadds",
      "RegionEndpoint": "ap-southeast-1"
    }
  },
  

</details> <details> <summary><b>Message Broker</b></summary>

• Open below files and jump to Messaging section:

  • ClassifiedAds.Background/appsettings.json

  "Messaging": {
    "Provider": "RabbitMQ",
  }
  

• Use RabbitMQ

  "Messaging": {
    "Provider": "RabbitMQ",
    "RabbitMQ": {
      "HostName": "localhost",
      "UserName": "guest",
      "Password": "guest",
      "ExchangeName": "amq.direct",
      "RoutingKeys": {
        "FileUploadedEvent": "classifiedadds_fileuploaded",
        "FileDeletedEvent": "classifiedadds_filedeleted",
        "EmailMessageCreatedEvent": "classifiedadds_emailcreated",
        "SmsMessageCreatedEvent": "classifiedadds_smscreated"
      },
      "QueueNames": {
        "FileUploadedEvent": "classifiedadds_fileuploaded",
        "FileDeletedEvent": "classifiedadds_filedeleted",
        "EmailMessageCreatedEvent": "classifiedadds_emailcreated",
        "SmsMessageCreatedEvent": "classifiedadds_smscreated"
      }
    }
  }
  

• Use Kafka:

  "Messaging": {
    "Provider": "Kafka",
    "Kafka": {
      "BootstrapServers": "localhost:9092",
      "Topics": {
        "FileUploadedEvent": "classifiedadds_fileuploaded",
        "FileDeletedEvent": "classifiedadds_filedeleted",
        "EmailMessageCreatedEvent": "classifiedadds_emailcreated",
        "SmsMessageCreatedEvent": "classifiedadds_smscreated"
      },
    }
  }
  

• Use Azure Queue Storage:

  "Messaging": {
    "Provider": "AzureQueue",
    "AzureQueue": {
      "ConnectionString": "xxx",
      "QueueNames": {
        "FileUploadedEvent": "classifiedadds-fileuploaded",
        "FileDeletedEvent": "classifiedadds-filedeleted",
        "EmailMessageCreatedEvent": "classifiedadds-emailcreated",
        "SmsMessageCreatedEvent": "classifiedadds-smscreated"
      }
    }
  }
  

• Use Azure Service Bus:

  "Messaging": {
    "Provider": "AzureServiceBus",
    "AzureServiceBus": {
      "ConnectionString": "xxx",
      "QueueNames": {
        "FileUploadedEvent": "classifiedadds_fileuploaded",
        "FileDeletedEvent": "classifiedadds_filedeleted",
        "EmailMessageCreatedEvent": "classifiedadds_emailcreated",
        "SmsMessageCreatedEvent": "classifiedadds_smscreated"
      }
    }
  }
  

</details> <details> <summary><b>Logging</b></summary>

• Open and jump to Logging section of below files:
  • ClassifiedAds.WebAPI/appsettings.json
  • ClassifiedAds.WebMVC/appsettings.json
  • ClassifiedAds.Background/appsettings.json

  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    },
    "File": {
      "MinimumLogEventLevel": "Information"
    },
    "Elasticsearch": {
      "IsEnabled": false,
      "Host": "http://localhost:9200",
      "IndexFormat": "classifiedads",
      "MinimumLogEventLevel": "Information"
    },
    "EventLog": {
      "IsEnabled": false,
      "LogName": "Application",
      "SourceName": "ClassifiedAds.WebAPI"
    }
  },
  

• Write to Local file (./logs/log.txt). Always enabled.

  "Logging": {
    "File": {
      "MinimumLogEventLevel": "Information"
    },
  },
  

• Write to Elasticsearch:

  "Logging": {
    "Elasticsearch": {
      "IsEnabled": true,
      "Host": "http://localhost:9200",
      "IndexFormat": "classifiedads",
      "MinimumLogEventLevel": "Information"
    },
  },
  

• Write to Windows Event Log (Windows only):

  "Logging": {
    "EventLog": {
      "IsEnabled": true,
      "LogName": "Application",
      "SourceName": "ClassifiedAds.WebAPI"
    }
  },
  

• Enable all options:

  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    },	
    "File": {
      "Min