Skip to content

Commit afa29ca

Browse files
authored
Update README.md
1 parent 855a47f commit afa29ca

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,42 +23,47 @@ dotnet new --install AspNetCoreTemplate
2323
dotnet new aspnet-core-template -n YourProjectName
2424
```
2525

26-
## Overview
26+
## Project Overview
27+
28+
![image](https://user-images.githubusercontent.com/25417032/97107962-056ef380-16d3-11eb-96a7-1a7dd7f859f6.png)
29+
30+
![Dependencies Graph](https://user-images.githubusercontent.com/25417032/97107966-0e5fc500-16d3-11eb-9b9c-c73012ff97ac.png)
31+
2732

2833
### Common
2934

30-
**AspNetCoreTemplate.Common** will contains common things for the project solution. For example:
35+
**AspNetCoreTemplate.Common** contains common things for the project solution. For example:
3136
- [GlobalConstants.cs](https://github.com/NikolayIT/ASP.NET-Core-Template/blob/master/src/AspNetCoreTemplate.Common/GlobalConstants.cs).
3237

3338
### Data
34-
This solution folder contains three subfolders
39+
This solution folder contains three subfolders:
3540
- AspNetCoreTemplate.Data.Common
3641
- AspNetCoreTemplate.Data.Models
3742
- AspNetCoreTemplate.Data
3843

3944
##### AspNetCoreTemplate.Data.Common
40-
[AspNetCoreTemplate.Data.Common.Models](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Data/AspNetCoreTemplate.Data.Common/Models) provides us abstract generics classes and interfaces, which holds information about our entities for example when the object is Created, Modified, Deleted or IsDeleted. It contains a property for the primary key as well.
45+
[AspNetCoreTemplate.Data.Common.Models](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Data/AspNetCoreTemplate.Data.Common/Models) provides abstract generics classes and interfaces, which holds information about our entities. For example when the object is Created, Modified, Deleted or IsDeleted. It contains a property for the primary key as well.
4146

42-
[AspNetCoreTemplate.Data.Common.Repositories](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Data/AspNetCoreTemplate.Data.Common/Repositories) provides two interfaces IDeletableEntityRepository and IRepository, which are part of our **repository pattern**.
47+
[AspNetCoreTemplate.Data.Common.Repositories](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Data/AspNetCoreTemplate.Data.Common/Repositories) provides two interfaces IDeletableEntityRepository and IRepository, which are part of the **repository pattern**.
4348

4449
##### AspNetCoreTemplate.Data.Models
4550
[AspNetCoreTemplate.Data.Models](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Data/AspNetCoreTemplate.Data.Models) contains ApplicationUser and ApplicationRole classes, which inherits IdentityRole and IdentityUsers.
4651

4752
##### AspNetCoreTemplate.Data
48-
[AspNetCoreTemplate.Data](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Data/AspNetCoreTemplate.Data) contains our DbContext, Migrations, Configuraitons. It holds our Seeding and Repository functionality.
53+
[AspNetCoreTemplate.Data](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Data/AspNetCoreTemplate.Data) contains DbContext, Migrations and Configuraitons for the EF Core.There is Seeding and Repository functionality as well.
4954

5055
### Services
51-
This solution folder contains four subfolders
56+
This solution folder contains four subfolders:
5257
- AspNetCoreTemplate.Services.Data
5358
- AspNetCoreTemplate.Services.Mapping
5459
- AspNetCoreTemplate.Services.Messaging
5560
- AspNetCoreTemplate.Services
5661

5762
##### AspNetCoreTemplate.Services.Data
58-
[AspNetCoreTemplate.Services.Data](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Services/AspNetCoreTemplate.Services.Data) wil contains our service layer.
63+
[AspNetCoreTemplate.Services.Data](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Services/AspNetCoreTemplate.Services.Data) wil contains service layer logic.
5964

6065
##### AspNetCoreTemplate.Services.Mapping
61-
[AspNetCoreTemplate.Services.Mapping](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Services/AspNetCoreTemplate.Services.Mapping) provides simplified functionlity for auto mapping. For example:
66+
[AspNetCoreTemplate.Services.Mapping](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Services/AspNetCoreTemplate.Services.Mapping) provides simplified functionlity for auto mapping. For example:
6267

6368
```csharp
6469
using Blog.Data.Models;
@@ -106,54 +111,51 @@ public class IndexPostViewModel : IMapFrom<Post>, IHaveCustomMappings
106111

107112
##### AspNetCoreTemplate.Services.Messaging
108113

109-
[AspNetCoreTemplate.Services.Messaging](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Services/AspNetCoreTemplate.Services.Messaging) a ready to use integration with [SendGrid](https://sendgrid.com/)
114+
[AspNetCoreTemplate.Services.Messaging](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Services/AspNetCoreTemplate.Services.Messaging) a ready to use integration with [SendGrid](https://sendgrid.com/).
110115

111116
##### AspNetCoreTemplate.Services
117+
[AspNetCoreTemplate.Services](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Services/AspNetCoreTemplate.Services)
112118

113-
[AspNetCoreTemplate.Services.Data](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Services/AspNetCoreTemplate.Services)
114-
115-
### Services
116-
This solution folder contains three subfolders
119+
### Tests
120+
This solution folder contains three subfolders:
117121
- AspNetCoreTemplate.Services.Data.Tests
118122
- AspNetCoreTemplate.Web.Tests
119123
- Sandbox
120124

121125
##### AspNetCoreTemplate.Services.Data.Tests
122126

123-
[AspNetCoreTemplate.Services.Data.Tests](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Tests/AspNetCoreTemplate.Services.Data.Tests) will hold unit tests for our service layer. It's already have installer XUnit.
127+
[AspNetCoreTemplate.Services.Data.Tests](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Tests/AspNetCoreTemplate.Services.Data.Tests) holds unit tests for our service layer with ready setted up xUnit.
124128

125129
##### AspNetCoreTemplate.Web.Tests
126130

127131
[AspNetCoreTemplate.Web.Tests](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Tests/AspNetCoreTemplate.Web.Tests) setted up Selenuim tests.
128132

129133
##### Sandbox
130-
131-
[Sandbox](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Tests/Sandbox)
134+
[Sandbox](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Tests/Sandbox) can be used to test your logic.
132135

133136
### Web
134-
This solution folder contains three subfolders
137+
This solution folder contains three subfolders:
135138
- AspNetCoreTemplate.Web.Infrastructure
136139
- AspNetCoreTemplate.Web.ViewModels
137140
- AspNetCoreTemplate.Web
138141

139142
##### AspNetCoreTemplate.Web.Infrastructure
140143

141-
[AspNetCoreTemplate.Web.Infrastructure](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Web/AspNetCoreTemplate.Web.Infrastructure) will contains functionality like Middlewares and Filters.
144+
[AspNetCoreTemplate.Web.Infrastructure](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Web/AspNetCoreTemplate.Web.Infrastructure) contains functionality like Middlewares and Filters.
142145

143146
##### AspNetCoreTemplate.Web.ViewModels
144147

145-
[AspNetCoreTemplate.Web.ViewModels](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Web/AspNetCoreTemplate.Web.ViewModels) will contains objects, which will be mapped from our entities and used in the front-end.
148+
[AspNetCoreTemplate.Web.ViewModels](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Web/AspNetCoreTemplate.Web.ViewModels) contains objects, which will be mapped from/to our entities and used in the front-end/back-end.
146149

147150
##### AspNetCoreTemplate.Web
148151

149-
[AspNetCoreTemplate.Web](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Web/AspNetCoreTemplate.Web)
152+
[AspNetCoreTemplate.Web](https://github.com/NikolayIT/ASP.NET-Core-Template/tree/master/src/Web/AspNetCoreTemplate.Web) self explanatory.
150153

151154
## Support
152155

153156
If you are having problems, please let us know by [raising a new issue](https://github.com/NikolayIT/ASP.NET-Core-Template/issues).
154157

155158
## Contributors
156-
157159
- [Stoyan Shopov](https://github.com/StoyanShopov)
158160

159161
## Example Projects

0 commit comments

Comments
 (0)