Giter Site home page Giter Site logo

mvandermeulen / practical.cleanarchitecture Goto Github PK

View Code? Open in Web Editor NEW

This project forked from phongnguyend/practical.cleanarchitecture

0.0 1.0 0.0 70.57 MB

Full-stack .Net 7 Clean Architecture (Microservices + Dapr, Modular Monolith, Monolith), Blazor, Angular 15, React 18, Vue 3, Domain-Driven Design, CQRS, SOLID, Asp.Net Core Identity Custom Storage, Identity Server, Entity Framework Core, Selenium, SignalR, Hosted Services, Health Checks, Rate Limiting, Cloud (Azure, AWS) Services, ...

Shell 0.07% JavaScript 7.93% C# 68.08% PowerShell 0.05% TypeScript 6.48% CSS 0.72% HTML 13.41% Vue 1.77% Dockerfile 1.11% Less 0.10% TSQL 0.28%

practical.cleanarchitecture's Introduction

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 alt text alt text

(open on draw.io)

Solution Structure

alt text

alt text

alt text

How to Run:

Update Configuration

Database

  • 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
Additional Configuration Sources

  • 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/"
  }
},
Storage

  • 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"
  }
},
Message Broker

  • 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"
    }
  }
}
Logging
  • 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"
  }
},
Caching
  • Open and jump to Caching section of below files: 
    "Caching": {
  "InMemory": {

  },
  "Distributed": {

  }
},
  • Configure options for In Memory Cache: 
    "Caching": {
  "InMemory": {
    "SizeLimit": null
  },
},
  • Use In Memory Distributed Cache (For Local Testing): 
    "Caching": {
  "Distributed": {
    "Provider": "InMemory",
    "InMemory": {
      "SizeLimit": null
    }
  }
},
  • Use Redis Distributed Cache: 
    "Caching": {
  "Distributed": {
    "Provider": "Redis",
    "Redis": {
      "Configuration": "xxx.redis.cache.windows.net:6380,password=xxx,ssl=True,abortConnect=False",
      "InstanceName": ""
    }
  }
},
  • Use Sql Server Distributed Cache: 
    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
    "Caching": {
  "Distributed": {
    "Provider": "SqlServer",
    "SqlServer": {
      "ConnectionString": "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#",
      "SchemaName": "dbo",
      "TableName": "CacheEntries"
    }
  }
},
Monitoring
  • Open and jump to Monitoring section of below files: 
    "Monitoring": {
  "MiniProfiler": {
    
  },
  "AzureApplicationInsights": {
    
  }
},
  • Use MiniProfiler: 
    "Monitoring": {
  "MiniProfiler": {
    "IsEnabled": true,
    "SqlServerStorage": {
      "ConectionString": "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#;MultipleActiveResultSets=true;Encrypt=False",
      "ProfilersTable": "MiniProfilers",
      "TimingsTable": "MiniProfilerTimings",
      "ClientTimingsTable": "MiniProfilerClientTimings"
    }
  },
},
  • Use Azure Application Insights: 
    "Monitoring": {
  "AzureApplicationInsights": {
    "IsEnabled": true,
	"InstrumentationKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
	"EnableSqlCommandTextInstrumentation": true
  }
},
  • Use AppMetrics: 
    "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: 
    "Monitoring": {
  "MiniProfiler": {
    "IsEnabled": true,
    "SqlServerStorage": {
      "ConectionString": "Server=127.0.0.1;Database=ClassifiedAds;User Id=sa;Password=sqladmin123!@#;MultipleActiveResultSets=true;Encrypt=False",
      "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
    }
  }
},
Interceptors
Security Headers
  • Open ClassifiedAds.WebAPI/appsettings.json and jump to SecurityHeaders section: 
    "SecurityHeaders": {
  "Cache-Control": "no-cache, no-store, must-revalidate",
  "Pragma": "no-cache",
  "Expires": "0"
},
  • Open ClassifiedAds.WebMVC/appsettings.json and jump to SecurityHeaders section: 
    "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"
},
Cross-Origin Resource Sharing (CORS)
External Login
  • Open ClassifiedAds.IdentityServer/appsettings.json and jump to ExternalLogin section: 
    "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"
  }
},
Sending Email
  • Open ClassifiedAds.BackgroundServer/appsettings.json and jump to Notification -> Email section: 
    "Notification": {
  "Email": {
    "Provider": "Fake",
  }
}
  • Use SmtpClient: 
    "Notification": {
  "Email": {
    "Provider": "SmtpClient",
    "SmtpClient": {
      "Host": "localhost",
      "Port": "",
      "UserName": "",
      "Password": "",
      "EnableSsl": ""
    }
  }
}
Sending SMS
  • Open ClassifiedAds.BackgroundServer/appsettings.json and jump to Notification -> Sms section: 
    "Notification": {
  "Sms": {
    "Provider": "Fake",
  }
}
  • Use Twilio 
    "Notification": {
  "Sms": {
    "Provider": "Twilio",
    "Twilio": {
      "AccountSId": "",
      "AuthToken": "",
      "FromNumber": ""
    }
  }
}

Set Startup Projects

alt text

Run or Debug the Solution

How to Build and Run Single Page Applications:

  • Angular:

    • Navigate to folder: UIs/angular/

      npm install
ng serve

    • Update environment.ts & environment.prod.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

  • React:

    • Navigate to folder: UIs/reactjs/

      npm install
npm run start

    • Update environment.dev.js & environment.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

  • Vue:

    • Navigate to folder: UIs/vuejs/ 
      npm install
npm run serve
    • Update environment.dev.js & environment.dev.js 
      const environment = {
    OpenIdConnect: {
        Authority: "https://localhost:44367",
        ClientId: "ClassifiedAds.Vue"
    },
    ResourceServer: {
        Endpoint: "https://localhost:44312/api/"
    },
    CurrentUrl: "http://localhost:8080/"
};
export default environment;

How to Run on Docker Containers:

How to Run Integration & End to End Tests:

  • Update ClassifiedAds.IntegrationTests/appsettings.json

    {
  "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": "[email protected]",
    "Password": "v*7Un8b4rcN@<-RN",
    "Scope": "ClassifiedAds.WebAPI"
  }
}

  • Download Chrome Driver

    alt text

  • Update ClassifiedAds.EndToEndTests/appsettings.json

    {
  "ChromeDriverPath": "D:\\Downloads\\chromedriver_win32\\72",
  "Login": {
    "Url": "https://localhost:44364/Home/Login",
    "UserName": "[email protected]",
    "Password": "v*7Un8b4rcN@<-RN"
  }
}

    alt text

Application URLs:

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

Roadmap:

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

practical.cleanarchitecture's People

Contributors

phongnguyend avatar amitpnk avatar igor-toporet avatar skobovm avatar qyperion avatar cuno92 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.