: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

alt text

(open on draw.io)

Hexagonal Architecture

alt text

(open on draw.io)

Onion Architecture

alt text

(open on draw.io)

The Clean Architecture

alt text

(open on draw.io)

Classic Three-layer Architecture

alt text

(open on draw.io)

Modern Four-layer Architecture

alt text

(open on draw.io)

Layer Dependencies

alt text

(open on draw.io)

Layer Examples

alt text

(open on draw.io)

Testing Pyramid

alt text

(open on draw.io)

Vertical Slice Architecture (Modular Monolith)

alt text

(open on draw.io)

Solution Structure

alt text

How to Run:

Update Configuration

<details> <summary>Database</summary>

Update Connection Strings:

Project	Configuration File	Configuration Key
ClassifiedAds.Migrator	appsettings.json	ConnectionStrings:ClassifiedAds
ClassifiedAds.BackgroundServer	appsettings.json	ConnectionStrings:ClassifiedAds
ClassifiedAds.IdentityServer	appsettings.json	ConnectionStrings:ClassifiedAds
ClassifiedAds.WebAPI	appsettings.json	ConnectionStrings:ClassifiedAds
ClassifiedAds.WebMVC	appsettings.json	ConnectionStrings:ClassifiedAds

Run Migration:

Option 1: Using dotnet cli:

Install dotnet-ef cli:

dotnet tool install --global dotnet-ef --version="5.0"

Navigate to ClassifiedAds.Migrator and run these commands:

dotnet ef migrations add Init --context AdsDbContext -o Migrations/AdsDb
dotnet ef migrations add Init --context ConfigurationDbContext -o Migrations/ConfigurationDb
dotnet ef migrations add Init --context PersistedGrantDbContext -o Migrations/PersistedGrantDb
dotnet ef database update --context AdsDbContext
dotnet ef database update --context ConfigurationDbContext
dotnet ef database update --context PersistedGrantDbContext

Option 2: Using Package Manager Console:

Set ClassifiedAds.Migrator as StartUp Project
Open Package Manager Console, select ClassifiedAds.Migrator as Default Project

Run these commands:

Add-Migration -Context AdsDbContext Init -OutputDir Migrations/AdsDb
Add-Migration -Context ConfigurationDbContext Init -OutputDir Migrations/ConfigurationDb
Add-Migration -Context PersistedGrantDbContext Init -OutputDir Migrations/PersistedGrantDb
Update-Database -Context AdsDbContext
Update-Database -Context ConfigurationDbContext
Update-Database -Context PersistedGrantDbContext

</details> <details> <summary>Additional Configuration Sources</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>Storage</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>Message Broker</summary>

Open below files and jump to MessageBroker section:
```
"MessageBroker": {
  "Provider": "RabbitMQ",
}
```

Use RabbitMQ

"MessageBroker": {
  "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:

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

Use Azure Queue Storage:

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

Use Azure Service Bus:

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

Use Azure Event Grid:

"MessageBroker": {
  "Provider": "AzureEventGrid",
  "AzureEventGrid": {
    "DomainEndpoint": "https://xxx.xxx-1.eventgrid.azure.net/api/events",
    "DomainKey": "xxxx",
    "Topics": {
      "FileUploadedEvent": "classifiedadds_fileuploaded",
      "FileDeletedEvent": "classifiedadds_filedeleted"
      "EmailMessageCreatedEvent": "classifiedadds_emailcreated",
      "SmsMessageCreatedEvent": "classifiedadds_smscreated"
    }
  }
}

Use Azure Event Hubs:

"MessageBroker": {
  "Provider": "AzureEventHub",
  "AzureEventHub": {
    "ConnectionString": "Endpoint=sb://xxx.servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=xxx",
    "Hubs": {
      "FileUploadedEvent": "classifiedadds_fileuploaded",
      "FileDeletedEvent": "classifiedadds_filedeleted",
      "EmailMessageCreatedEvent": "classifiedadds_emailcreated",
      "SmsMessageCreatedEvent": "classifiedadds_smscreated"
    },
    "StorageConnectionString": "DefaultEndpointsProtocol=https;AccountName=xxx;AccountKey=xxx;EndpointSuffix=core.windows.net",
    "StorageContainerNames": {
      "FileUploadedEvent": "eventhub-fileuploaded",
      "FileDeletedEvent": "eventhub-filedeleted",
      "EmailMessageCreatedEvent": "eventhub-emailcreated",
      "SmsMessageCreatedEvent": "eventhub-smscreated"
    }
  }
}

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

Open and jump to Logging section of below files:

"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": {
    "MinimumLogEventLevel": "Information"
  },
  "Elasticsearch": {
    "IsEnabled": true,
    "Host": "http://localhost:9200",
    "IndexFormat": "classifiedads",
    "MinimumLogEventLevel": "Information"
  },
  "EventLog": {
    "IsEnabled": true,
    "LogName": "Application",
    "SourceName": "ClassifiedAds.WebAPI"
  }
},