Skip to content

Commit a69d7d8

Browse files
dejpanahdejpanah
authored
Initial commit
0 parents  commit a69d7d8

File tree

391 files changed

+83361
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

391 files changed

+83361
-0
lines changed

‎.editorconfig

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
###############################
2+
# Core EditorConfig Options #
3+
###############################
4+
root = true
5+
# All files
6+
[*]
7+
indent_style = space
8+
9+
# XML project files
10+
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
11+
indent_size = 2
12+
13+
# XML config files
14+
[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
15+
indent_size = 2
16+
17+
# Code files
18+
[*.{cs,csx,vb,vbx}]
19+
indent_size = 2
20+
insert_final_newline = true
21+
charset = utf-8-bom
22+
###############################
23+
# .NET Coding Conventions #
24+
###############################
25+
[*.{cs,vb}]
26+
# Organize usings
27+
dotnet_sort_system_directives_first = true
28+
# this. preferences
29+
dotnet_style_qualification_for_field = false:silent
30+
dotnet_style_qualification_for_property = false:silent
31+
dotnet_style_qualification_for_method = false:silent
32+
dotnet_style_qualification_for_event = false:silent
33+
# Language keywords vs BCL types preferences
34+
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
35+
dotnet_style_predefined_type_for_member_access = true:silent
36+
# Parentheses preferences
37+
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
38+
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
39+
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
40+
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
41+
# Modifier preferences
42+
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
43+
dotnet_style_readonly_field = true:suggestion
44+
# Expression-level preferences
45+
dotnet_style_object_initializer = true:suggestion
46+
dotnet_style_collection_initializer = true:suggestion
47+
dotnet_style_explicit_tuple_names = true:suggestion
48+
dotnet_style_null_propagation = true:suggestion
49+
dotnet_style_coalesce_expression = true:suggestion
50+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
51+
dotnet_style_prefer_inferred_tuple_names = true:suggestion
52+
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
53+
dotnet_style_prefer_auto_properties = true:silent
54+
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
55+
dotnet_style_prefer_conditional_expression_over_return = true:silent
56+
###############################
57+
# Naming Conventions #
58+
###############################
59+
# Style Definitions
60+
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
61+
# Use PascalCase for constant fields
62+
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
63+
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
64+
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
65+
dotnet_naming_symbols.constant_fields.applicable_kinds = field
66+
dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
67+
dotnet_naming_symbols.constant_fields.required_modifiers = const
68+
tab_width= 2
69+
dotnet_naming_rule.private_members_with_underscore.symbols = private_fields
70+
dotnet_naming_rule.private_members_with_underscore.style = prefix_underscore
71+
dotnet_naming_rule.private_members_with_underscore.severity = suggestion
72+
dotnet_naming_symbols.private_fields.applicable_kinds = field
73+
dotnet_naming_symbols.private_fields.applicable_accessibilities = private
74+
dotnet_naming_style.prefix_underscore.capitalization = camel_case
75+
dotnet_naming_style.prefix_underscore.required_prefix = _
76+
dotnet_style_operator_placement_when_wrapping = beginning_of_line
77+
end_of_line = crlf
78+
###############################
79+
# C# Coding Conventions #
80+
###############################
81+
[*.cs]
82+
# var preferences
83+
csharp_style_var_for_built_in_types = true:silent
84+
csharp_style_var_when_type_is_apparent = true:silent
85+
csharp_style_var_elsewhere = true:silent
86+
# Expression-bodied members
87+
csharp_style_expression_bodied_methods = false:silent
88+
csharp_style_expression_bodied_constructors = false:silent
89+
csharp_style_expression_bodied_operators = false:silent
90+
csharp_style_expression_bodied_properties = true:silent
91+
csharp_style_expression_bodied_indexers = true:silent
92+
csharp_style_expression_bodied_accessors = true:silent
93+
# Pattern matching preferences
94+
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
95+
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
96+
# Null-checking preferences
97+
csharp_style_throw_expression = true:suggestion
98+
csharp_style_conditional_delegate_call = true:suggestion
99+
# Modifier preferences
100+
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
101+
# Expression-level preferences
102+
csharp_prefer_braces = true:silent
103+
csharp_style_deconstructed_variable_declaration = true:suggestion
104+
csharp_prefer_simple_default_expression = true:suggestion
105+
csharp_style_pattern_local_over_anonymous_function = true:suggestion
106+
csharp_style_inlined_variable_declaration = true:suggestion
107+
# Namespaces
108+
csharp_style_namespace_declarations = file_scoped:warning
109+
###############################
110+
# C# Formatting Rules #
111+
###############################
112+
# New line preferences
113+
csharp_new_line_before_open_brace = all
114+
csharp_new_line_before_else = true
115+
csharp_new_line_before_catch = true
116+
csharp_new_line_before_finally = true
117+
csharp_new_line_before_members_in_object_initializers = true
118+
csharp_new_line_before_members_in_anonymous_types = true
119+
csharp_new_line_between_query_expression_clauses = true
120+
# Indentation preferences
121+
csharp_indent_case_contents = true
122+
csharp_indent_switch_labels = true
123+
csharp_indent_labels = flush_left
124+
# Space preferences
125+
csharp_space_after_cast = false
126+
csharp_space_after_keywords_in_control_flow_statements = true
127+
csharp_space_between_method_call_parameter_list_parentheses = false
128+
csharp_space_between_method_declaration_parameter_list_parentheses = false
129+
csharp_space_between_parentheses = false
130+
csharp_space_before_colon_in_inheritance_clause = true
131+
csharp_space_after_colon_in_inheritance_clause = true
132+
csharp_space_around_binary_operators = before_and_after
133+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
134+
csharp_space_between_method_call_name_and_opening_parenthesis = false
135+
csharp_space_between_method_call_empty_parameter_list_parentheses = false
136+
# Wrapping preferences
137+
csharp_preserve_single_line_statements = true
138+
csharp_preserve_single_line_blocks = true
139+
csharp_using_directive_placement = outside_namespace:suggestion
140+
csharp_prefer_simple_using_statement = true:suggestion
141+
csharp_style_prefer_method_group_conversion = true:silent
142+
csharp_style_prefer_top_level_statements = true:silent
143+
csharp_style_prefer_primary_constructors = true:suggestion
144+
csharp_style_expression_bodied_lambdas = true:silent
145+
csharp_style_expression_bodied_local_functions = false:silent
146+
###############################
147+
# VB Coding Conventions #
148+
###############################
149+
[*.vb]
150+
# Modifier preferences
151+
visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public,Friend,NotOverridable,Overridable,MustOverride,Overloads,Overrides,MustInherit,NotInheritable,Static,Shared,Shadows,ReadOnly,WriteOnly,Dim,Const,WithEvents,Widening,Narrowing,Custom,Async:suggestion

‎.github/CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to CleanArchitecture
2+
3+
**First:** if you're unsure or afraid of _anything_, just ask or submit the
4+
issue or pull request anyways. You won't be yelled at for giving your best
5+
effort. The worst that can happen is that you'll be politely asked to change
6+
something. We appreciate any sort of contributions, and don't want a wall of
7+
rules to get in the way of that.
8+
9+
However, for those individuals who want a bit more guidance on the best way to
10+
contribute to the project, read on. This document will cover what we're looking
11+
for. By addressing all the points we're looking for, it raises the chances we
12+
can quickly merge or address your contributions.
13+
14+
## Issues
15+
16+
### Reporting an Issue
17+
18+
* Make sure you test against the latest released version. It is possible we
19+
already fixed the bug you're experiencing.
20+
21+
* If you can, check and see if there is an existing open issue that is already
22+
reporting the problem. Feel free to upvote this issue or comment on it to
23+
describe your specific scenario (assuming it's the same underlying issue).
24+
25+
* Provide a reproducible test case. If a contributor can't reproduce an issue,
26+
then it dramatically lowers the chances it'll get fixed. And in some cases,
27+
the issue will eventually be closed.
28+
29+
* Respond promptly to any questions made by the maintainers about your issue. Stale
30+
issues will be closed (eventually).
31+
32+
## Pull Requests
33+
34+
* Pull requests are welcome but are most likely to be accepted when they address
35+
an existing issue. A common workflow is to create an issue describing the problem
36+
your PR would solve, and then volunteer to submit a PR addressing the issue as an
37+
initial comment on the issue.
38+
39+
* As much as possible, pull requests should follow the existing coding conventions
40+
used by the project. This is generally true for any project. The only exception to
41+
this would be a pull request whose purpose is to adjust the coding conventions used
42+
by the project.
43+
44+
* When possible, issues will be marked with a `help wanted` tag if community contributions
45+
are particularly welcome for them. This will often be the case for relatively simple
46+
fixes that would make good initial contributions.
47+
48+
* If your PR addresses an issue, please include "Fixes #NNN" in the summary for the PR
49+
so that the issue is linked to the PR (and vice versa) and if/when the PR is merged,
50+
the issue is automatically closed.
51+
52+
Thank you for reading this and for considering contributing to this project!
53+

‎.github/FUNDING.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: [ardalis]

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
<!-- ⚠️⚠️ Do Not Delete This! bug_report_template ⚠️⚠️ -->
6+
<!-- 🔎 Search existing issues to avoid creating duplicates. -->
7+
8+
- .NET SDK Version:
9+
10+
Steps to Reproduce:
11+
12+
1.
13+
2.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question
4+
url: https://stackoverflow.com/questions/tagged/ardalis-cleanarchitecture
5+
about: Please ask and answer questions on Stack Overflow.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
<!-- ⚠️⚠️ Do Not Delete This! feature_request_template ⚠️⚠️ -->
8+
<!-- Please search existing issues to avoid creating duplicates. -->
9+
10+
<!-- Describe the feature you'd like. -->

‎.github/copilot-instructions.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# GitHub Copilot Instructions for Clean Architecture Template
2+
3+
## Project Overview
4+
This is a **Clean Architecture template** for .NET 9 that demonstrates Domain-Driven Design (DDD) patterns. It's a starter template, not a reference application - delete sample code once you understand the patterns.
5+
6+
## Architecture & Project Structure
7+
8+
### Core Dependencies Flow
9+
- **Core** ← UseCases ← Infrastructure
10+
- **Core** ← UseCases ← Web
11+
- Never allow Core to depend on outer layers
12+
13+
### Key Projects
14+
- **Core**: Domain entities, aggregates, value objects, specifications, interfaces
15+
- **UseCases**: Commands/queries (CQRS), MediatR handlers, application logic
16+
- **Infrastructure**: EF Core, external services, email, file access
17+
- **Web**: FastEndpoints API, REPR pattern, validation
18+
19+
## Development Patterns
20+
21+
### API Endpoints (FastEndpoints + REPR)
22+
- One endpoint per file: `Create.cs`, `Update.cs`, `Delete.cs`, `GetById.cs`
23+
- Separate request/response/validator files: `Create.CreateRequest.cs`, `Create.CreateValidator.cs`
24+
- Use `Endpoint<TRequest, TResponse>` base class
25+
- Example: `src/Clean.Architecture.Web/Contributors/Create.cs`
26+
27+
### Domain Model (Core)
28+
- Entities use encapsulation - minimize public setters
29+
- Group related entities into Aggregates
30+
- Use Value Objects (e.g., `ContributorName.From()`)
31+
- Domain Events for cross-aggregate communication
32+
- Repository interfaces defined in Core, implemented in Infrastructure
33+
34+
### Use Cases (CQRS)
35+
- Commands for mutations, Queries for reads
36+
- Queries can bypass repository pattern for performance
37+
- Use MediatR for command/query handling
38+
- Chain of responsibility for cross-cutting concerns (logging, validation)
39+
40+
### Validation Strategy
41+
- **API Level**: FluentValidation on request DTOs (FastEndpoints integration)
42+
- **Use Case Level**: Validate commands/queries (defensive coding)
43+
- **Domain Level**: Business invariants throw exceptions, assume pre-validated input
44+
45+
## Essential Commands
46+
47+
### Build & Test
48+
```bash
49+
dotnet build Clean.Architecture.sln
50+
dotnet test Clean.Architecture.sln
51+
```
52+
53+
### Entity Framework Migrations
54+
```bash
55+
# From Web project directory
56+
dotnet ef migrations add MigrationName -c AppDbContext -p ../Clean.Architecture.Infrastructure/Clean.Architecture.Infrastructure.csproj -s Clean.Architecture.Web.csproj -o Data/Migrations
57+
58+
dotnet ef database update -c AppDbContext -p ../Clean.Architecture.Infrastructure/Clean.Architecture.Infrastructure.csproj -s Clean.Architecture.Web.csproj
59+
```
60+
61+
### Template Installation & Usage
62+
```bash
63+
dotnet new install Ardalis.CleanArchitecture.Template
64+
dotnet new clean-arch -o Your.ProjectName
65+
```
66+
67+
## Key Dependencies & Patterns
68+
69+
### Primary Libraries
70+
- **FastEndpoints**: API endpoints (replaced Controllers/Minimal APIs)
71+
- **MediatR**: Command/query handling in UseCases
72+
- **EF Core**: Data access (SQLite default, easily changed to SQL Server)
73+
- **Ardalis.Specification**: Repository query specifications
74+
- **Ardalis.Result**: Error handling pattern
75+
- **Serilog**: Structured logging
76+
77+
### Central Package Management
78+
- All package versions in `Directory.Packages.props`
79+
- Use `<PackageReference Include="..." />` without Version attribute
80+
81+
### Test Organization
82+
- **UnitTests**: Core business logic, use cases
83+
- **IntegrationTests**: Database, infrastructure components
84+
- **FunctionalTests**: API endpoints (subcutaneous testing)
85+
- Use `Microsoft.AspNetCore.Mvc.Testing` for API tests
86+
87+
## File Organization Conventions
88+
89+
### Web Project Structure
90+
```
91+
Contributors/
92+
Create.cs # Endpoint
93+
Create.CreateRequest.cs # Request DTO
94+
Create.CreateResponse.cs # Response DTO
95+
Create.CreateValidator.cs # FluentValidation
96+
Update.cs, Delete.cs, etc.
97+
```
98+
99+
### Sample vs Template
100+
- `/sample` folder: Complete working example (NimblePros.SampleToDo)
101+
- `/src` folder: Clean template ready for your project
102+
- Study sample for patterns, use src for new projects
103+
104+
## Common Gotchas
105+
106+
- Don't include hyphens in project names (template limitation)
107+
- Replace `Ardalis.SharedKernel` with your own shared kernel
108+
- Database path in `appsettings.json` for SQLite
109+
- Use absolute paths in EF migration commands
110+
- FastEndpoints uses different validation approach than Controller-based APIs
111+
112+
## VS Code Tasks
113+
Use the predefined tasks: `build`, `publish`, `watch` instead of manual `dotnet` commands when possible.

‎.github/dependabot.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: nuget
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
open-pull-requests-limit: 10

0 commit comments

Comments
 (0)