Skip to content

Commit 0c24665

Browse files
committed
Streamline README, add links to Wiki
1 parent f3613b1 commit 0c24665

8 files changed

+13
-59
lines changed

README.md

+13-59
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
<a href="https://dot.net/architecture">
2-
<img src="https://github.com/dotnet-architecture/eShopOnContainers/raw/dev/img/eshop_logo.png" alt="eShop logo" title="eShopOnContainers" align="right" height="60" />
2+
<img src="https://github.com/dotnet-architecture/eShopOnContainers/raw/dev/img/eshop_logo.png" alt="eShop logo" title="eShopOnContainers" align="right" height="60" />
33
</a>
44

5-
# .NET Microservices Reference Application
5+
# .NET Microservices Sample Reference Application
66

77
Sample .NET Core reference application, powered by Microsoft, based on a simplified microservices architecture and Docker containers.
8-
<img src="img/eshop-webmvc-app-screenshot.png">
8+
9+
![](img/eshop-webmvc-app-screenshot.png)
910

1011
## Azure DevOps - Build Status
1112

@@ -28,18 +29,18 @@ eShopOnContainers is provided in two flavors: Basic and Advanced.
2829

2930
### Basic scenario
3031

31-
Basic scenario cab be run locally using docker compose, and also deployed to a local Kubernetes cluster. Refer these Wiki to Get Started:
32+
The basic scenario can be run locally using docker compose, and also deployed to a local Kubernetes cluster. Refer these Wiki pages to Get Started:
3233

33-
- [Using Visual Studio](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Windows-setup)
34-
- Using CLI or Visual Studio Code
35-
- Using docker compose
36-
- Using local Kubernetes
34+
- [CLI or Visual Studio Code](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Windows-setup)
35+
- [Visual Studio (F5 experience)](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Windows-setup#optional---use-visual-studio)
36+
- [Docker compose](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Docker-compose-deployment-files)
37+
- [Local Kubernetes](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Deploy-to-Local-Kubernetes)
3738

3839
### Advanced scenario
3940

4041
The Advanced scenario can be run only in a Kubernetes cluster. Currently this scenario is the same as basic scenario with the following differences:
4142

42-
- Use of a Service Mesh for Resiliency
43+
- [Deploy to AKS with a Service Mesh for resiliency](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Deploy-to-Azure-Kubernetes-Service-(AKS))
4344

4445
In the future more features will be implemented in the advanced scenario.
4546

@@ -54,56 +55,9 @@ Do you want to be up-to-date on .NET Architecture guidance and reference apps li
5455

5556
## Updated for .NET Core 3.0
5657

57-
eShopOnContainers is updated to .NET Core 3.0 "wave" of technologies. Not just compilation but also new recommended code in EF Core, ASP.NET Core, and other new related versions.
58-
59-
### Details on the latest mayor release
60-
61-
- Migrate solution from ASP.NET Core 2.2 to 3.0 and update all projects to use the latest .NET Core 3.0 templates.
62-
63-
- Implement the new .NET Core 3.0 WorkerService in Ordering.API and other background processes.
64-
65-
- Improve Ordering.API
66-
- Group order items
67-
- apply discounts from Marketing.API
68-
69-
- Handle two deployment scenarios
70-
- Basic deployment, better for learning:
71-
- Docker compose
72-
- Local Kubernetes
73-
- Visual Studio F5 experience
74-
75-
- Advanced deployment, complex but more real-life:
76-
- Sidecar implementation with Envoy/Linkerd
77-
- Improved API Gateway and resilience
78-
- gRPC for inter-service communications
79-
- Test and Support Azure Dev Spaces
80-
81-
### New folder structure
82-
83-
The repo also has a new, simpler, folder structure, as shown in the following image:
84-
85-
![](img/new-folder-structure.png)
86-
87-
In the above image you can see that the first folder level contains, basically:
58+
eShopOnContainers is updated to .NET Core 3.0 "wave" of technologies. Not just compilation but also new recommended code in EF Core, ASP.NET Core, and other new related versions and a several significant changes.
8859

89-
- **build**: Scripts for building Docker images.
90-
- **deploy**: Scripts for deployment.
91-
- **src**: All source projects, including tests.
92-
- **ApiGateways**: Envoy configuration and Aggregators source code.
93-
- **BuildBlocks**: Common components used by several projects.
94-
- **Mobile**: Mobile apps projects.
95-
- **Services**: Backend for all services. Including unit and functional tests for some projects.
96-
- Basket
97-
- Catalog
98-
- Identity
99-
- Location
100-
- Marketing
101-
- Ordering
102-
- Payment
103-
- Webhooks
104-
- **Tests**: General functional application tests.
105-
- **test-results**: Test results
106-
- **Web**: Web applications
60+
See more details in the [Release notes](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Release-notes) wiki page.
10761

10862
>**PLEASE** Read our [branch guide](./branch-guide.md) to know about our branching policy
10963
>
@@ -117,7 +71,7 @@ This reference application is cross-platform at the server and client side, than
11771
The architecture proposes a microservice oriented architecture implementation with multiple autonomous microservices (each one owning its own data/db) and implementing different approaches within each microservice (simple CRUD vs. DDD/CQRS patterns) using Http as the communication protocol between the client apps and the microservices and supports asynchronous communication for data updates propagation across multiple services based on Integration Events and an Event Bus (a light message broker, to choose between RabbitMQ or Azure Service Bus, underneath) plus other features defined at the [roadmap](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Roadmap).
11872

11973
![](img/eshop_logo.png)
120-
![](https://user-images.githubusercontent.com/1712635/38758862-d4b42498-3f27-11e8-8dad-db60b0fa05d3.png)
74+
![](img/eShopOnContainers-architecture.png)
12175

12276
## Related documentation and guidance
12377

Binary file not shown.
205 KB
Loading
-156 KB
Binary file not shown.

img/eshop-webspa-app-screenshot.png

-1.67 MB
Binary file not shown.

img/new-folder-structure.png

-10.9 KB
Binary file not shown.

img/vs-solution-structure.png

-383 KB
Binary file not shown.

img/xamarin-mobile-App.png

-189 KB
Binary file not shown.

0 commit comments

Comments
 (0)