README.md · pikaih/Practical.CleanArchitecture

# Database Centric vs Domain Centric Architecture 
![alt text](/docs/imgs/database-centrics-vs-domain-centric-architecture.png)

[*(open on draw.io)*](https://www.draw.io/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fphongnguyend%2FPractical.CleanArchitecture%2Fmaster%2Fdocs%2Fimgs%2Fdatabase-centrics-vs-domain-centric-architecture.drawio)

# Hexagonal Architecture
![alt text](/docs/imgs/hexagonal-architecture.png)

[*(open on draw.io)*](https://www.draw.io/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fphongnguyend%2FPractical.CleanArchitecture%2Fmaster%2Fdocs%2Fimgs%2Fhexagonal-architecture.drawio)

# Onion Architecture
![alt text](/docs/imgs/onion-architecture.png)

[*(open on draw.io)*](https://www.draw.io/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fphongnguyend%2FPractical.CleanArchitecture%2Fmaster%2Fdocs%2Fimgs%2Fonion-architecture.drawio)

# The Clean Architecture
![alt text](/docs/imgs/the-clean-architecture.png)

[*(open on draw.io)*](https://www.draw.io/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fphongnguyend%2FPractical.CleanArchitecture%2Fmaster%2Fdocs%2Fimgs%2Fthe-clean-architecture.drawio)

# Classic Three-layer Architecture
![alt text](/docs/imgs/classic-three-layer-architecture.png)

[*(open on draw.io)*](https://www.draw.io/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fphongnguyend%2FPractical.CleanArchitecture%2Fmaster%2Fdocs%2Fimgs%2Fclassic-three-layer-architecture.drawio)

# Modern Four-layer Architecture
![alt text](/docs/imgs/modern-four-layer-architecture.png)

[*(open on draw.io)*](https://www.draw.io/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fphongnguyend%2FPractical.CleanArchitecture%2Fmaster%2Fdocs%2Fimgs%2Fmodern-four-layer-architecture.drawio)

# Layer Dependencies
![alt text](/docs/imgs/layer-dependencies.png)

[*(open on draw.io)*](https://www.draw.io/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fphongnguyend%2FPractical.CleanArchitecture%2Fmaster%2Fdocs%2Fimgs%2Flayer-dependencies.drawio)

# Layer Examples
![alt text](/docs/imgs/layer-examples.png)

[*(open on draw.io)*](https://www.draw.io/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fphongnguyend%2FPractical.CleanArchitecture%2Fmaster%2Fdocs%2Fimgs%2Flayer-examples.drawio)

# Testing Pyramid
![alt text](/docs/imgs/testing-pyramid.png)
![alt text](/docs/imgs/testing-pyramid-unit-tests.png)
![alt text](/docs/imgs/testing-pyramid-integration-e2e-tests.png)

[*(open on draw.io)*](https://www.draw.io/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fphongnguyend%2FPractical.CleanArchitecture%2Fmaster%2Fdocs%2Fimgs%2Ftesting-pyramid.drawio)

# Solution Structure
![alt text](/docs/imgs/code-solution-structure.png)

![alt text](/docs/imgs/code-solution-structure-modular-monolith.png)

![alt text](/docs/imgs/code-solution-structure-microservices.png)

# How to Run:
## Update Configuration
<details>
 <summary>Database</summary>
 
- Update Connection Strings:

| Project  | Configuration File | Configuration Key |
  | -------- | ------------------ | ----------------- |
  | ClassifiedAds.Migrator | [appsettings.json](/src/Monolith/ClassifiedAds.Migrator/appsettings.json) | ConnectionStrings:ClassifiedAds |
  | ClassifiedAds.BackgroundServer | [appsettings.json](/src/Monolith/ClassifiedAds.BackgroundServer/appsettings.json) | ConnectionStrings:ClassifiedAds |
  | ClassifiedAds.IdentityServer | [appsettings.json](/src/Monolith/ClassifiedAds.IdentityServer/appsettings.json) | ConnectionStrings:ClassifiedAds |
  | ClassifiedAds.WebAPI | [appsettings.json](/src/Monolith/ClassifiedAds.WebAPI/appsettings.json) | ConnectionStrings:ClassifiedAds |
  | ClassifiedAds.WebMVC | [appsettings.json](/src/Monolith/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](/src/Monolith/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](/src/Monolith/ClassifiedAds.WebMVC/appsettings.json) and jump to **ConfigurationSources** section.
 ```js
 "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:
    ```js
    "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:
    ```js
    "ConfigurationSources": {
      "AzureKeyVault": {
        "IsEnabled": true,
        "VaultName": "https://xxx.vault.azure.net/"
      }
    },
    ```

- Use Both:
 ```js
 "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](/src/Monolith/ClassifiedAds.WebMVC/appsettings.json), [ClassifiedAds.WebAPI/appsettings.json](/src/Monolith/ClassifiedAds.WebAPI/appsettings.json) and jump to **Storage** section.
 ```js
 "Storage": {
 "Provider": "Local",
 },
 ```

- Use Local Files:
    ```js
    "Storage": {
      "Provider": "Local",
      "Local": {
        "Path": "E:\\files"
      },
    },
    ```

- Use Azure Blob:
    ```js
    "Storage": {
      "Provider": "Azure",
      "Azure": {
        "ConnectionString": "xxx",
        "Container": "classifiedadds"
      },
    },
    ```

- Use Amazon S3:
 ```js
 "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:
 + [ClassifiedAds.IdentityServer/appsettings.json](/src/Monolith/ClassifiedAds.IdentityServer/appsettings.json)
 + [ClassifiedAds.WebMVC/appsettings.json](/src/Monolith/ClassifiedAds.WebMVC/appsettings.json)
 + [ClassifiedAds.WebAPI/appsettings.json](/src/Monolith/ClassifiedAds.WebAPI/appsettings.json)
 + [ClassifiedAds.BackgroundServer/appsettings.json](/src/Monolith/ClassifiedAds.BackgroundServer/appsettings.json)
 ```js
 "MessageBroker": {
 "Provider": "RabbitMQ",
 }
 ```

- Use RabbitMQ
    ```js
    "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:
    ```js
    "MessageBroker": {
      "Provider": "Kafka",
      "Kafka": {
        "BootstrapServers": "localhost:9092",
        "Topics": {
          "FileUploadedEvent": "classifiedadds_fileuploaded",
          "FileDeletedEvent": "classifiedadds_filedeleted",
          "EmailMessageCreatedEvent": "classifiedadds_emailcreated",
          "SmsMessageCreatedEvent": "classifiedadds_smscreated"
        },
      }
    }
    ```

- Use Azure Queue Storage:
    ```js
    "MessageBroker": {
      "Provider": "AzureQueue",
      "AzureQueue": {
        "ConnectionString": "xxx",
        "QueueNames": {
          "FileUploadedEvent": "classifiedadds-fileuploaded",
          "FileDeletedEvent": "classifiedadds-filedeleted",
          "EmailMessageCreatedEvent": "classifiedadds-emailcreated",
          "SmsMessageCreatedEvent": "classifiedadds-smscreated"
        }
      }
    }
    ```

- Use Azure Service Bus:
 ```js
 "MessageBroker": {
 "Provider": "AzureServiceBus",
 "AzureServiceBus": {
 "ConnectionString": "xxx",
 "QueueNames": {
 "FileUploadedEvent": "classifiedadds_fileuploaded",
 "FileDeletedEvent": "classifiedadds_filedeleted",
 "EmailMessageCreatedEvent": "classifiedadds_emailcreated",
 "SmsMessageCreatedEvent": "classifiedadds_smscreated"
 }
 }
 }
 ```
	
 - Use Azure Event Grid:
 ```js
 "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:
 ```js
 "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:
 + [ClassifiedAds.WebAPI/appsettings.json](/src/Monolith/ClassifiedAds.WebAPI/appsettings.json)
 + [ClassifiedAds.WebMVC/appsettings.json](/src/Monolith/ClassifiedAds.WebMVC/appsettings.json)
 + [ClassifiedAds.IdentityServer/appsettings.json](/src/Monolith/ClassifiedAds.IdentityServer/appsettings.json)
 + [ClassifiedAds.BackgroundServer/appsettings.json](/src/Monolith/ClassifiedAds.BackgroundServer/appsettings.json)
 ```js
 "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.
 ```js
 "Logging": {
 "File": {
 "MinimumLogEventLevel": "Information"
 },
 },
 ```
 - Write to Elasticsearch:
 ```js
 "Logging": {
 "Elasticsearch": {
 "IsEnabled": true,
 "Host": "http://localhost:9200",
 "IndexFormat": "classifiedads",
 "MinimumLogEventLevel": "Information"
 },
 },
 ```
 - Write to Windows Event Log (Windows only):
 ```js
 "Logging": {
 "EventLog": {
 "IsEnabled": true,
 "LogName": "Application",
 "SourceName": "ClassifiedAds.WebAPI"
 }
 },
 ```
 - Enable all options:
 ```js
 "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"
 }
 },
 ```
</details>

<details>
 <summary>Caching</summary>
 
 - Open and jump to **Caching** section of below files:
 + [ClassifiedAds.WebAPI/appsettings.json](/src/Monolith/ClassifiedAds.WebAPI/appsettings.json)
 + [ClassifiedAds.WebMVC/appsettings.json](/src/Monolith/ClassifiedAds.WebMVC/appsettings.json)
 + [ClassifiedAds.IdentityServer/appsettings.json](/src/Monolith/ClassifiedAds.IdentityServer/appsettings.json)
 ```js
 "Caching": {
 "InMemory": {

},
      "Distributed": {

}
 },
 ```
 - Configure options for In Memory Cache:
 ```js
 "Caching": {
 "InMemory": {
 "SizeLimit": null
 },
 },
 ```
 - Use In Memory Distributed Cache (For Local Testing):
 ```js
 "Caching": {
 "Distributed": {
 "Provider": "InMemory",
 "InMemory": {
 "SizeLimit": null
 }
 }
 },
 ```
 - Use Redis Distributed Cache:
 ```js
 "Caching": {
 "Distributed": {
 "Provider": "Redis",
 "Redis": {
 "Configuration": "xxx.redis.cache.windows.net:6380,password=xxx,ssl=True,abortConnect=False",
 "InstanceName": ""
 }
 }
 },
 ```
 - Use Sql Server Distributed Cache:
 ```js
	dotnet tool install --global dotnet-sql-cache --version="5.0"
	dotnet sql-cache create "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#" dbo CacheEntries
 ```
 ```js
 "Caching": {
 "Distributed": {
 "Provider": "SqlServer",
 "SqlServer": {
 "ConnectionString": "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#",
 "SchemaName": "dbo",
 "TableName": "CacheEntries"
 }
 }
 },
 ```
</details>

<details>
 <summary>Monitoring</summary>
 
 - Open and jump to **Monitoring** section of below files:
 + [ClassifiedAds.WebAPI/appsettings.json](/src/Monolith/ClassifiedAds.WebAPI/appsettings.json)
 + [ClassifiedAds.WebMVC/appsettings.json](/src/Monolith/ClassifiedAds.WebMVC/appsettings.json)
 + [ClassifiedAds.IdentityServer/appsettings.json](/src/Monolith/ClassifiedAds.IdentityServer/appsettings.json)
 ```js
 "Monitoring": {
 "MiniProfiler": {
 
 },
 "AzureApplicationInsights": {
 
 }
 },
 ```
 - Use MiniProfiler:
 ```js
 "Monitoring": {
 "MiniProfiler": {
 "IsEnabled": true,
 "SqlServerStorage": {
 "ConectionString": "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#;MultipleActiveResultSets=true",
 "ProfilersTable": "MiniProfilers",
 "TimingsTable": "MiniProfilerTimings",
 "ClientTimingsTable": "MiniProfilerClientTimings"
 }
 },
 },
 ```
 - Use Azure Application Insights:
 ```js
	"Monitoring": {
 "AzureApplicationInsights": {
 "IsEnabled": true,
		"InstrumentationKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		"EnableSqlCommandTextInstrumentation": true
 }
	},
 ```
 - Use AppMetrics:
 ```js
	"Monitoring": {
 "AppMetrics": {
 "IsEnabled": true,
 "MetricsOptions": {
 "DefaultContextLabel": "ClassifiedAds.WebAPI",
 "Enabled": true,
 "ReportingEnabled": true
 },
 "MetricsWebTrackingOptions": {
 "ApdexTrackingEnabled": true,
 "ApdexTSeconds": 0.1,
 "IgnoredHttpStatusCodes": [ 404 ],
 "IgnoredRoutesRegexPatterns": [],
 "OAuth2TrackingEnabled": true
 },
 "MetricEndpointsOptions": {
 "MetricsEndpointEnabled": true,
 "MetricsTextEndpointEnabled": true,
 "EnvironmentInfoEndpointEnabled": true
 }
 }
	},
 ```
 - Use Both:
 ```js
 "Monitoring": {
 "MiniProfiler": {
 "IsEnabled": true,
 "SqlServerStorage": {
 "ConectionString": "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#;MultipleActiveResultSets=true",
 "ProfilersTable": "MiniProfilers",
 "TimingsTable": "MiniProfilerTimings",
 "ClientTimingsTable": "MiniProfilerClientTimings"
 }
 },
 "AzureApplicationInsights": {
 "IsEnabled": true,
 "InstrumentationKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
 "EnableSqlCommandTextInstrumentation": true
 },
 "AppMetrics": {
 "IsEnabled": true,
 "MetricsOptions": {
 "DefaultContextLabel": "ClassifiedAds.WebAPI",
 "Enabled": true,
 "ReportingEnabled": true
 },
 "MetricsWebTrackingOptions": {
 "ApdexTrackingEnabled": true,
 "ApdexTSeconds": 0.1,
 "IgnoredHttpStatusCodes": [ 404 ],
 "IgnoredRoutesRegexPatterns": [],
 "OAuth2TrackingEnabled": true
 },
 "MetricEndpointsOptions": {
 "MetricsEndpointEnabled": true,
 "MetricsTextEndpointEnabled": true,
 "EnvironmentInfoEndpointEnabled": true
 }
 }
 },
 ```
</details>

<details>
 <summary>Interceptors</summary>
 
 - Open and jump to **Interceptors** section of below files:
 + [ClassifiedAds.WebAPI/appsettings.json](/src/Monolith/ClassifiedAds.WebAPI/appsettings.json)
 + [ClassifiedAds.WebMVC/appsettings.json](/src/Monolith/ClassifiedAds.WebMVC/appsettings.json)
 + [ClassifiedAds.IdentityServer/appsettings.json](/src/Monolith/ClassifiedAds.IdentityServer/appsettings.json)
 + [ClassifiedAds.BackgroundServer/appsettings.json](/src/Monolith/ClassifiedAds.BackgroundServer/appsettings.json)
 ```js
 "Interceptors": {
 "LoggingInterceptor": true,
 "ErrorCatchingInterceptor": false
 },
 ```
</details>

<details>
 <summary>Security Headers</summary>
 
 - Open [ClassifiedAds.WebAPI/appsettings.json](/src/Monolith/ClassifiedAds.WebAPI/appsettings.json) and jump to **SecurityHeaders** section:
 ```js
 "SecurityHeaders": {
 "Cache-Control": "no-cache, no-store, must-revalidate",
 "Pragma": "no-cache",
 "Expires": "0"
 },
 ```
 - Open [ClassifiedAds.WebMVC/appsettings.json](/src/Monolith/ClassifiedAds.WebMVC/appsettings.json) and jump to **SecurityHeaders** section:
 ```js
 "SecurityHeaders": {
 "Content-Security-Policy": "form-action 'self'; frame-ancestors 'none'",
 "Feature-Policy": "camera 'none'",
 "Referrer-Policy": "strict-origin-when-cross-origin",
 "X-Content-Type-Options": "nosniff",
 "X-Frame-Options": "DENY",
 "X-XSS-Protection": "1; mode=block",
 "Cache-Control": "no-cache, no-store, must-revalidate",
 "Pragma": "no-cache",
 "Expires": "0"
 },
 ```
</details>

<details>
 <summary>Cross-Origin Resource Sharing (CORS)</summary>
 
 - Open [ClassifiedAds.WebAPI/appsettings.json](/src/Monolith/ClassifiedAds.WebAPI/appsettings.json) and jump to **CORS** section:
 ```js
 "CORS": {
 "AllowAnyOrigin": false,
 "AllowedOrigins": [ "http://localhost:4200", "http://localhost:3000", "http://localhost:8080" ]
 },
 ```
 - Open [ClassifiedAds.NotificationServer/appsettings.json](/src/Monolith/ClassifiedAds.NotificationServer/appsettings.json) and jump to **CORS** section:
 ```js
 "CORS": {
 "AllowedOrigins": [ "https://localhost:44364", "http://host.docker.internal:9003" ]
 }
 ```
</details>

<details>
 <summary>External Login</summary>
 
 - Open [ClassifiedAds.IdentityServer/appsettings.json](/src/Monolith/ClassifiedAds.IdentityServer/appsettings.json) and jump to **ExternalLogin** section:
 ```js
 "ExternalLogin": {
 "AzureActiveDirectory": {
 "IsEnabled": true,
 "Authority": "https://login.microsoftonline.com/<Directory (tenant) ID>",
 "ClientId": "<Application (client) ID",
 "ClientSecret": "xxx"
 },
 "Microsoft": {
 "IsEnabled": true,
 "ClientId": "<Application (client) ID",
 "ClientSecret": "xxx"
 },
 "Google": {
 "IsEnabled": true,
 "ClientId": "xxx",
 "ClientSecret": "xxx"
 },
 "Facebook": {
 "IsEnabled": true,
 "AppId": "xxx",
 "AppSecret": "xxx"
 }
 },
 ```
</details>

<details>
 <summary>Sending Email</summary>
 
 - Open [ClassifiedAds.BackgroundServer/appsettings.json](/src/Monolith/ClassifiedAds.BackgroundServer/appsettings.json) and jump to **Notification -> Email** section:
 ```js
 "Notification": {
 "Email": {
 "Provider": "Fake",
 }
 }
 ```
 - Use SmtpClient:
 ```js
 "Notification": {
 "Email": {
 "Provider": "SmtpClient",
 "SmtpClient": {
 "Host": "localhost",
 "Port": "",
 "UserName": "",
 "Password": "",
 "EnableSsl": ""
 }
 }
 }
 ```
</details>

<details>
 <summary>Sending SMS</summary>
 
 - Open [ClassifiedAds.BackgroundServer/appsettings.json](/src/Monolith/ClassifiedAds.BackgroundServer/appsettings.json) and jump to **Notification -> Sms** section:
 ```js
 "Notification": {
 "Sms": {
 "Provider": "Fake",
 }
 }
 ```
 - Use Twilio
 ```js
 "Notification": {
 "Sms": {
 "Provider": "Twilio",
 "Twilio": {
 "AccountSId": "",
 "AuthToken": "",
 "FromNumber": ""
 }
 }
 }
 ```
</details>

## Set Startup Projects
![alt text](/docs/imgs/startup-projects.png)

## Run or Debug the Solution
- Web MVC Home Page: https://localhost:44364/

![alt text](/docs/imgs/web-mvc-home-page.png)

- Navigate to Health Checks UI https://localhost:44364/healthchecks-ui#/healthchecks and make sure everything is green.

![alt text](/docs/imgs/health-checks-ui.png)

- Login on Identity Server:
 + Option 1: Use default created account:
 + User Name: phong@gmail.com
 + Password: v*7Un8b4rcN@<-RN
 + Option 2: Register new account at https://localhost:44367/Account/Register
 
 ![alt text](/docs/imgs/identity-server-login-page.png)

- Open Blazor Home Page at: https://localhost:44331

![alt text](/docs/imgs/blazor-home-page.png)

## How to Build and Run Single Page Applications:
- Angular:
  + Navigate to folder: [UIs/angular/](/src/UIs/angular/)
    ```
    npm install
    ng serve
    ```
  + Update [environment.ts](/src/UIs/angular/src/environments/environment.ts) & [environment.prod.ts](/src/UIs/angular/src/environments/environment.prod.ts) 
    ```ts
    export const environment = {
      OpenIdConnect: {
        Authority: "https://localhost:44367",
        ClientId: "ClassifiedAds.Angular"
      },
      ResourceServer: {
        Endpoint: "https://localhost:44312/api/"
      },
      CurrentUrl: "http://localhost:4200/"
    };
    ```
  + Go to http://localhost:4200/

![alt text](/docs/imgs/angular-home-page.png)
  
- React:
  + Navigate to folder: [UIs/reactjs/](/src/UIs/reactjs/)
    ```
    npm install
    npm run start
    ```
  + Update [environment.dev.js](/src/UIs/reactjs/src/environments/environment.dev.js) & [environment.js](/src/UIs/reactjs/src/environments/environment.js) 
    ```js
    const environment = {
        OpenIdConnect: {
            Authority: "https://localhost:44367",
            ClientId: "ClassifiedAds.React"
        },
        ResourceServer: {
            Endpoint: "https://localhost:44312/api/"
        },
        CurrentUrl: "http://localhost:3000/"
    };
    export default environment;
    ```
  + Go to http://localhost:3000/
  
    ![alt text](/docs/imgs/react-home-page.png)
  
- Vue:
  + Navigate to folder: [UIs/vuejs/](/src/UIs/vuejs/)
    ```
    npm install
    npm run serve
    ```
  + Update [environment.dev.js](/src/UIs/vuejs/environments/environment.dev.js) & [environment.dev.js](/src/UIs/vuejs/environments/environment.js) 
    ```js
    const environment = {
        OpenIdConnect: {
            Authority: "https://localhost:44367",
            ClientId: "ClassifiedAds.Vue"
        },
        ResourceServer: {
            Endpoint: "https://localhost:44312/api/"
        },
        CurrentUrl: "http://localhost:8080/"
    };
    export default environment;
    ```
+ Go to http://localhost:8080/
  
    ![alt text](/docs/imgs/vue-home-page.png)

- Before Login, go to Identity Server https://localhost:44367/Client to make sure application clients have been registered:

![alt text](/docs/imgs/identity-server-clients-page.png)
    
## How to Run on Docker Containers:
- Add Migrations if you haven't done on previous steps:
  + Install **dotnet-ef** cli:
    ```
    dotnet tool install --global dotnet-ef --version="5.0"
    ```
  + Navigate to [ClassifiedAds.Migrator](/src/Monolith/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
    ```
- Navigate to [Monolith](/src/Monolith/) and run:
  ```
  docker-compose build
  docker-compose up
  ```
- Open Web MVC Home Page at: http://host.docker.internal:9003

![alt text](/docs/imgs/web-mvc-home-page.png)

- Navigate to Health Checks UI http://host.docker.internal:9003/healthchecks-ui#/healthchecks and make sure everything is green.

![alt text](/docs/imgs/health-checks-ui-container.png)

- Login on Identity Server:
 + Use default created account: phong@gmail.com / v*7Un8b4rcN@<-RN
 + Register new account at http://host.docker.internal:9000/Account/Register
 
- Open Blazor Home Page at: http://host.docker.internal:9008

![alt text](/docs/imgs/blazor-home-page.png)

## How to Run Integration & End to End Tests:
- Update [ClassifiedAds.IntegrationTests/appsettings.json](/src/Monolith/ClassifiedAds.IntegrationTests/appsettings.json)
 ```js
 {
 "OpenIdConnect": {
 "Authority": "https://localhost:44367",
 "ClientId": "ClassifiedAds.WebMVC",
 "ClientSecret": "secret",
 "RequireHttpsMetadata": "true"
 },
 "WebAPI": {
 "Endpoint": "https://localhost:44312"
 },
 "GraphQL": {
 "Endpoint": "https://localhost:44392/graphql"
 },
 "Login": {
 "UserName": "phong@gmail.com",
 "Password": "v*7Un8b4rcN@<-RN",
 "Scope": "ClassifiedAds.WebAPI"
 }
 }
 ```
- Download [Chrome Driver](https://chromedriver.chromium.org/downloads)

![alt text](/docs/imgs/chrome_driver_path.png)

- Update [ClassifiedAds.EndToEndTests/appsettings.json](/src/Monolith/ClassifiedAds.EndToEndTests/appsettings.json)
 ```js
 {
 "ChromeDriverPath": "D:\\Downloads\\chromedriver_win32\\72",
 "Login": {
 "Url": "https://localhost:44364/Home/Login",
 "UserName": "phong@gmail.com",
 "Password": "v*7Un8b4rcN@<-RN"
 }
 }
 ```
 
 ![alt text](/docs/imgs/run_e2e_tests.gif)
 
## Application URLs:

https://github.com/phongnguyend/Practical.CleanArchitecture/wiki/Application-URLs

## Roadmap:

https://github.com/phongnguyend/Practical.CleanArchitecture/wiki/Roadmap

pikaih/Practical.CleanArchitecture

简介

发行版

贡献者

语言

近期动态

pikaih/Practical.CleanArchitecture .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

语言

近期动态

搜索帮助

pikaih/Practical.CleanArchitecture