Skip to content

Commit 1e038f5

Browse files
committed
updated readme
1 parent fb1ae60 commit 1e038f5

File tree

2 files changed

+126
-9
lines changed

2 files changed

+126
-9
lines changed

Assert/Step.png

26.7 KB
Loading

README.md

Lines changed: 126 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,140 @@
1-
# Onion architecture with ASP.NET Core API
2-
3-
WhiteApp or QuickApp API solution template which is built on Domain-Driven Design (DDD) based with all essential feature using .NET Core
1+
[![Visual Studio Marketplace version](https://img.shields.io/badge/-OnionArchitecture-%23e2165e.svg)](https://marketplace.visualstudio.com/items?itemName=AmitNaik.OnionArchitecture)
2+
[![Visual Studio Marketplace downloads](https://vsmarketplacebadge.apphb.com/installs/GregTrevellick.CleanArchitecture.svg)](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.CleanArchitecture)
3+
[![Visual Studio Marketplace ratings](https://vsmarketplacebadge.apphb.com/rating/GregTrevellick.CleanArchitecture.svg)](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.CleanArchitecture)
4+
[![Visual Studio Marketplace version](https://vsmarketplacebadge.apphb.com/version/GregTrevellick.CleanArchitecture.svg)](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.CleanArchitecture)
5+
6+
7+
# Onion architecture with ASP.NET Core
8+
9+
<br />
10+
<p align="center">
11+
<a href="#">
12+
<img src="Assert/OnionArchitecture_icon.png" alt="Logo" width="80" height="80">
13+
</a>
14+
15+
<h3 align="center">Onion Architecture</h3>
16+
17+
<p align="center">
18+
WhiteApp or QuickApp API solution template which is built on Onion Architecture with all essential feature using .NET Core!
19+
<br />
20+
<a href="#"><strong>Explore the docs »</strong></a>
21+
<br />
22+
<br />
23+
<a href="https://marketplace.visualstudio.com/items?itemName=AmitNaik.OnionArchitecture">Download from Marketplace</a>
24+
·
25+
<a href="https://github.com/Amitpnk/Onion-architecture-ASP.NET-Core/issues">Report Bug</a>
26+
·
27+
<a href="https://github.com/Amitpnk/Onion-architecture-ASP.NET-Core/issues/new">Request Feature</a>
28+
</p>
29+
</p>
30+
31+
32+
## Now available as a [project template](https://marketplace.visualstudio.com/items?itemName=AmitNaik.OnionArchitecture) within Visual Studio Extension
33+
34+
## Give a Star! :star:
35+
If you like or are using this project to learn or start your solution, please give it a star. Thanks!
36+
37+
<!-- TABLE OF CONTENTS -->
38+
## Table of Contents
39+
40+
* [Onion Architecture](#Onion-Architecture)
41+
* [reference](#reference)
42+
* [About the Project](#about-the-project)
43+
<!-- * [Built With](#built-with) -->
44+
* [Getting Started](#getting-started)
45+
* [Prerequisites](#prerequisites)
46+
* [Installation](#installation)
47+
* [Usage](#usage)
48+
* [Roadmap](#roadmap)
49+
* [Contributing](#contributing)
50+
* [License](#license)
51+
* [Contact](#contact)
52+
* [Acknowledgements](#acknowledgements)
53+
54+
## Onion Architecture
55+
56+
Onion Architecture was introduced by Jeffrey Palermo to provide a better way to build applications in perspective of better testability, maintainability, and dependability on the infrastructures like databases and services
457

558
Onion, Clean or Hexagonal architecture: it's all the same. Which is built on Domain-Driven Desgin approach.
659

760
Domain in center and building layer top of it. You can call it as Domain-centric Architecture too.
861

9-
* [Referenced by Article - Mark Seemann](https://blog.ploeh.dk/2013/12/03/layers-onions-ports-adapters-its-all-the-same/)
62+
### Reference
63+
64+
* [It's all the same (Domain centeric architecture) - Mark Seemann](https://blog.ploeh.dk/2013/12/03/layers-onions-ports-adapters-its-all-the-same/)
1065
* [Onion Architecture by Jeffrey Palermo](https://jeffreypalermo.com/2008/07/the-onion-architecture-part-1/)
1166
* [Clean Architecture by Robert C. Martin (Uncle Bob)
1267
](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)
1368
* [Hexagonal Architecture by Dr. Alistair Cockburn](https://alistair.cockburn.us/hexagonal+architecture)
1469

70+
## About The Project
71+
72+
[![Product Name Screen Shot][product-screenshot]](https://example.com)
73+
74+
WhiteApp or QuickApp API solution template which is built on Onion Architecture with all essential feature using .NET Core.
75+
76+
![image](Assert/Onion.png)
77+
<!-- ### Built With
78+
79+
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
80+
* [ASP.NET Core](https://getbootstrap.com)
81+
* [SQL Server](https://jquery.com) -->
82+
83+
84+
1585

1686
## Licence Used
17-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
87+
[![MIT License][license-shield]][license-url]
1888

1989
See the contents of the LICENSE file for details
2090

91+
92+
## Getting Started
93+
94+
### Step 1: Download extension from project template
95+
96+
<p> <a href="https://marketplace.visualstudio.com/items?itemName=AmitNaik.OnionArchitecture">Download from Marketplace</a></p>
97+
98+
![image](Assert/Step.png)
99+
100+
### Step 2: Create Project
101+
102+
Select project type as API, and select Onion Architecture
103+
104+
![image](Assert/Step1.png)
105+
106+
### Step 3: Select Onion Architecture project template
107+
108+
Select project type as API, and select Onion Architecture
109+
110+
![image](Assert/Step2.png)
111+
112+
### Step 4: Project is ready
113+
114+
![image](Assert/Step3.png)
115+
116+
### Step 5: Create Database
117+
118+
For Code First approach
119+
120+
```sh
121+
Update-Database
122+
```
123+
124+
For Database First approach
125+
126+
In Package Manager console in *<< ProjectName >>.Data*, run below command
127+
128+
```sh
129+
scaffold-dbcontext -provider Microsoft.EntityFrameworkCore.SqlServer -connection "Data Source=(local)\SQLexpress;Initial Catalog=OnionArchitectureDBS;Integrated Security=True"
130+
```
131+
132+
### Step 6: Build and run application
133+
134+
Swagger UI
135+
136+
![image](Assert/Step4.png)
137+
21138
## Support This Project
22139

23140
If you have found this project helpful, either as a library that you use or as a learning tool, please consider buying me a coffee:
@@ -26,10 +143,6 @@ If you have found this project helpful, either as a library that you use or as a
26143

27144
I do coding for fun during leisure time, but I have to pay the bills, so I also work for money :P
28145

29-
## Onion architecture
30-
31-
![image](Assert/Onion.png)
32-
33146
## Whiteapp Onion architecture with ASP.NET Core API
34147

35148
This is default white application for ASP.NET Core API development
@@ -58,3 +171,7 @@ Below features will be implemented in infrastructure layer. You can plug and pla
58171
- [ ] Email
59172
- [ ] Advanced Pagination
60173
- [ ] CQRS Pattern
174+
175+
176+
[license-shield]: https://img.shields.io/badge/License-MIT-yellow.svg
177+
[license-url]: https://github.com/Amitpnk/Onion-architecture-ASP.NET-Core/blob/master/LICENSE.txt

0 commit comments

Comments
 (0)