# eShopOnContainers - Microservices Architecture and Containers based Reference Application (**BETA state** - Visual Studio 2017 and CLI environments compatible)
Sample .NET Core reference application, powered by Microsoft, based on a simplified microservices architecture and Docker containers. <p>
**Note Visual Studio 2017 version required**: This is important as of Oct. 11th 2017. For working with Docker and docker-compose files (needed with eShopOnContainers), do not migrate to VS 2017 15.4 as it has a bug when using TAGs in the docker-compose files.
Please, either use VS 2017 15.35 or VS 2017 15.5 Preview 1 (bug is fixed here) or later.
**Note Visual Studio 2017 version required**: This is important as of November 2017. For working with Docker and docker-compose files (needed with eShopOnContainers), do not migrate to VS 2017 15.4 as it has a bug when using TAGs in the docker-compose files.
Please, either use VS 2017 15.35 or VS 2017 15.5 Preview (bug is fixed here) or later.
VS Preview installs next to your stable Visual Studio IDE, allowing you to use either independently.
Download of Preview here: https://www.visualstudio.com/vs/preview/
**Note for Pull Requests**: We accept pull request from the community. When doing it, please do it onto the DEV branch which is the consolidated work-in-progress branch. Do not request it onto Master, if possible.
## Moving to .NET Core 2.0 "wave"
NOTE: During August/September 2017 we'll be moving the solution to .NET Core "wave". Not just compilation but also new recommended code in EF Core 2.0, ASP.NET Core 2.0, and other new related versions.
## Updated for .NET Core 2.0 "wave" of technologies
NOTE: We have migrated the whole solution to .NET Core 2.0 "wave". Not just compilation but also new recommended code in EF Core 2.0, ASP.NET Core 2.0, and other new related versions.
For a list on the new .NET Core 2.0 related implemented features, see this [blog post](https://blogs.msdn.microsoft.com/dotnet/2017/08/02/microservices-and-docker-containers-architecture-patterns-and-development-guidance/).
>**PLEASE** Read our [branch guide](./branch-guide.md) to know about our branching policy
> ### DISCLAIMER
> **IMPORTANT:** The current state of this sample application is **BETA**, consider it version 0.1, a foundational version. Therefore, many areas could be improved and change significantly while refactoring current code and implementing new features. Feedback with improvements and pull requests from the community will be highly appreciated and accepted.
> **IMPORTANT:** The current state of this sample application is **BETA**, because we are constantly evolving towards new released technologies. Therefore, many areas could be improved and change significantly while refactoring current code and implementing new features. Feedback with improvements and pull requests from the community will be highly appreciated and accepted.
>
> This reference application proposes a simplified microservice oriented architecture implementation to introduce technologies like .NET Core with Docker containers through a comprehensive application. The chosen domain is an eShop/eCommerce but simply because it is a well-know domain by most people/developers.
However, this sample application should not be considered as an "eCommerce reference model", at all. The implemented business domain might not be ideal from an eCommerce business point of view. It is neither trying to solve all the problems in a large, scalable and mission-critical distributed system. It is just a bootstrap for developers to easily get started in the world of Docker containers and microservices with .NET Core.
> <p>For example, the next step (still not covered in eShopOnContainers) after understanding Docker containers and microservices development with .NET Core, is to select a microservice cluster/orchestrator like Docker Swarm, Kubernetes or DC/OS (in Azure Container Service) or Azure Service Fabric which in most of the cases will require additional partial changes to your application's configuration (although the present architecture should work on most orchestrators with small changes).
> Additional steps would be to move your databases to HA cloud services, or to implement your EventBus with Azure Service Bus or any other production ready Service Bus in the market.
> <p>In the future we might fork this project and make multiple versions targeting specific microservice cluster/orchestrators plus using additional cloud infrastructure. <p>
> <p>For example, the next step after running the solution in the local dev PC and understanding Docker containers and microservices development with .NET Core, is to select a microservice cluster/orchestrator like Kubernetes in Azure or Azure Service Fabric, both environments tested and supported by this solution.
> Additional steps would be to move your databases to HA cloud services (like Azure SQL Database), or to implement your EventBus with Azure Service Bus or any other production ready Service Bus in the market.
> Read the planned <ahref='https://github.com/dotnet/eShopOnContainers/wiki/01.-Roadmap-and-Milestones-for-future-releases'>Roadmap and Milestones for future releases of eShopOnContainers</a> within the Wiki for further info about possible new implementations and provide feedback at the <ahref='https://github.com/dotnet/eShopOnContainers/issues'>ISSUES section</a> if you'd like to see any specific scenario implemented or improved. Also, feel free to discuss on any current issue.
@ -59,11 +60,13 @@ You can download them and start reviewing these Guides/eBooks here:
Download in other formats (**eReaders** like **MOBI**, **EPUB**) and other eBooks at the [.NET Architecture center](dot.net/architecture).
Send feedback to [dotnet-architecture-ebooks-feedback@service.microsoft.com](dotnet-architecture-ebooks-feedback@service.microsoft.com)
<p>
However, we encourage to download and review the "Architecting & Developing eBook" because the architectural styles and architectural patterns and technologies explained in the guidance are using this reference application when explaining many pattern implementations, so you'll understand much better the context, design and decisions taken in the current architecture and internal designs.
However, we encourage to download and review the [Architecting and Developing Microservices eBook](https://aka.ms/microservicesebook) because the architectural styles and architectural patterns and technologies explained in the guidance are using this reference application when explaining many pattern implementations, so you'll understand much better the context, design and decisions taken in the current architecture and internal designs.
## Overview of the application code
In this repo you can find a sample reference application that will help you to understand how to implement a microservice architecture based application using <b>.NET Core</b> and <b>Docker</b>.
@ -82,7 +85,7 @@ Finally, those microservices are consumed by multiple client web and mobile apps
<b>*MVC Application (ASP.NET Core)*</b>: It's an MVC application where you can find interesting scenarios on how to consume HTTP-based microservices from C# running in the server side, as it is a typical ASP.NET Core MVC application. Since it is a server-side application, access to other containers/microservices is done within the internal Docker Host network with its internal name resolution.
<imgsrc="img/eshop-webmvc-app-screenshot.png">
<br>
<b>*SPA (Single Page Application)*</b>: Providing similar "eShop business functionality" but developed with Angular 2, Typescript and slightly using ASP.NET Core MVC. This is another approach for client web applications to be used when you want to have a more modern client behavior which is not behaving with the typical browser round-trip on every action but behaving like a Single-Page-Application which is more similar to a desktop app usage experience. The consumption of the HTTP-based microservices is done from TypeScript/JavaScript in the client browser, so the client calls to the microservices come from out of the Docker Host internal network (Like from your network or even from the Internet).
<b>*SPA (Single Page Application)*</b>: Providing similar "eShop business functionality" but developed with Angular, Typescript and slightly using ASP.NET Core MVC. This is another approach for client web applications to be used when you want to have a more modern client behavior which is not behaving with the typical browser round-trip on every action but behaving like a Single-Page-Application which is more similar to a desktop app usage experience. The consumption of the HTTP-based microservices is done from TypeScript/JavaScript in the client browser, so the client calls to the microservices come from out of the Docker Host internal network (Like from your network or even from the Internet).
<imgsrc="img/eshop-webspa-app-screenshot.png">
<br>
<b>*Xamarin Mobile App (For iOS, Android and Windows/UWP)*</b>: It is a client mobile app supporting the most common mobile OS platforms (iOS, Android and Windows/UWP). In this case, the consumption of the microservices is done from C# but running on the client devices, so out of the Docker Host internal network (Like from your network or even the Internet).
@ -99,12 +102,11 @@ For those who prefer the CLI on Windows, using dotnet CLI, docker CLI and VS Cod
See at the Wiki the posts on setup/instructions about how to deploy to Kubernetes or Service Fabric in Azure (although you could also deploy to any other cloud or on-premises).
See at the [Wiki](https://github.com/dotnet-architecture/eShopOnContainers/wiki) the posts on setup/instructions about how to deploy to Kubernetes or Service Fabric in Azure (although you could also deploy to any other cloud or on-premises).
## Sending feedback and pull requests
As mentioned, we'd appreciate your feedback, improvements and ideas.
newBasketItem{Id="1",PictureUrl=Device.RuntimePlatform!=Device.Windows?"fake_product_01.png":"Assets/fake_product_01.png",ProductId=Common.Common.MockCatalogItemId01,ProductName=".NET Bot Blue Sweatshirt (M)",Quantity=1,UnitPrice=19.50M},
newBasketItem{Id="2",PictureUrl=Device.RuntimePlatform!=Device.Windows?"fake_product_04.png":"Assets/fake_product_04.png",ProductId=Common.Common.MockCatalogItemId04,ProductName=".NET Black Cupt",Quantity=1,UnitPrice=17.00M}
newBasketItem{Id="1",PictureUrl=Device.RuntimePlatform!=Device.UWP?"fake_product_01.png":"Assets/fake_product_01.png",ProductId=Common.Common.MockCatalogItemId01,ProductName=".NET Bot Blue Sweatshirt (M)",Quantity=1,UnitPrice=19.50M},
newBasketItem{Id="2",PictureUrl=Device.RuntimePlatform!=Device.UWP?"fake_product_04.png":"Assets/fake_product_04.png",ProductId=Common.Common.MockCatalogItemId04,ProductName=".NET Black Cupt",Quantity=1,UnitPrice=17.00M}
newCatalogItem{Id=Common.Common.MockCatalogItemId03,PictureUri=Device.RuntimePlatform!=Device.Windows?"fake_product_03.png":"Assets/fake_product_03.png",Name=".NET Bot Black Sweatshirt (M)",Price=19.95M,CatalogBrandId=2,CatalogBrand="Visual Studio",CatalogTypeId=2,CatalogType="T-Shirt"},
newCatalogItem{Id=Common.Common.MockCatalogItemId04,PictureUri=Device.RuntimePlatform!=Device.Windows?"fake_product_04.png":"Assets/fake_product_04.png",Name=".NET Black Cupt",Price=17.00M,CatalogBrandId=2,CatalogBrand="Visual Studio",CatalogTypeId=1,CatalogType="Mug"},
newCatalogItem{Id=Common.Common.MockCatalogItemId05,PictureUri=Device.RuntimePlatform!=Device.Windows?"fake_product_05.png":"Assets/fake_product_05.png",Name="Azure Black Sweatshirt (M)",Price=19.50M,CatalogBrandId=1,CatalogBrand="Azure",CatalogTypeId=2,CatalogType="T-Shirt"}
newCatalogItem{Id=Common.Common.MockCatalogItemId01,PictureUri=Device.RuntimePlatform!=Device.UWP?"fake_product_01.png":"Assets/fake_product_01.png",Name=".NET Bot Blue Sweatshirt (M)",Price=19.50M,CatalogBrandId=2,CatalogBrand="Visual Studio",CatalogTypeId=2,CatalogType="T-Shirt"},
newCatalogItem{Id=Common.Common.MockCatalogItemId03,PictureUri=Device.RuntimePlatform!=Device.UWP?"fake_product_03.png":"Assets/fake_product_03.png",Name=".NET Bot Black Sweatshirt (M)",Price=19.95M,CatalogBrandId=2,CatalogBrand="Visual Studio",CatalogTypeId=2,CatalogType="T-Shirt"},
newCatalogItem{Id=Common.Common.MockCatalogItemId04,PictureUri=Device.RuntimePlatform!=Device.UWP?"fake_product_04.png":"Assets/fake_product_04.png",Name=".NET Black Cupt",Price=17.00M,CatalogBrandId=2,CatalogBrand="Visual Studio",CatalogTypeId=1,CatalogType="Mug"},
newCatalogItem{Id=Common.Common.MockCatalogItemId05,PictureUri=Device.RuntimePlatform!=Device.UWP?"fake_product_05.png":"Assets/fake_product_05.png",Name="Azure Black Sweatshirt (M)",Price=19.50M,CatalogBrandId=1,CatalogBrand="Azure",CatalogTypeId=2,CatalogType="T-Shirt"}
newOrderItem{OrderId=Guid.NewGuid(),ProductId=Common.Common.MockCatalogItemId01,Discount=15,ProductName=".NET Bot Blue Sweatshirt (M)",Quantity=1,UnitPrice=16.50M,PictureUrl=Device.RuntimePlatform!=Device.Windows?"fake_product_01.png":"Assets/fake_product_01.png"},
newOrderItem{OrderId=Guid.NewGuid(),ProductId=Common.Common.MockCatalogItemId03,Discount=0,ProductName=".NET Bot Black Sweatshirt (M)",Quantity=2,UnitPrice=19.95M,PictureUrl=Device.RuntimePlatform!=Device.Windows?"fake_product_03.png":"Assets/fake_product_03.png"}
newOrderItem{OrderId=Guid.NewGuid(),ProductId=Common.Common.MockCatalogItemId01,Discount=15,ProductName=".NET Bot Blue Sweatshirt (M)",Quantity=1,UnitPrice=16.50M,PictureUrl=Device.RuntimePlatform!=Device.UWP?"fake_product_01.png":"Assets/fake_product_01.png"},
newOrderItem{OrderId=Guid.NewGuid(),ProductId=Common.Common.MockCatalogItemId03,Discount=0,ProductName=".NET Bot Black Sweatshirt (M)",Quantity=2,UnitPrice=19.95M,PictureUrl=Device.RuntimePlatform!=Device.UWP?"fake_product_03.png":"Assets/fake_product_03.png"}
<ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
<ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
<ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
/// <summary>
/// Base class for implementing a long running <see cref="IHostedService"/>.
/// IMPORTANT: This base class is implemented in .NET Core 2.1 - Since this microservice is still in .NET Core 2.0, we're using the class within the project
/// When .NET Core 2.1 is released, this class should be removed and you should use the use implemented by the framework
Ramón Tomás
7 years ago
