# coolstore-microservices **Repository Path**: iagiler/coolstore-microservices ## Basic Information - **Project Name**: coolstore-microservices - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: develop - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-10-24 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # CoolStore Web Application - :ferris_wheel: Kubernetes-based Microservices Application on Service Mesh :sailboat: ![Travis (.org)](https://travis-ci.org/vietnam-devs/coolstore-microservices.svg?branch=master) [![Price](https://img.shields.io/badge/price-FREE-0098f7.svg)](https://github.com/vietnam-devs/coolstore-microservices/blob/master/LICENSE) [![OpenTracing Badge](https://img.shields.io/badge/OpenTracing-enabled-blue.svg)](http://opentracing.io) ``` ______ ______ ______ __ ______ ______ ______ ______ ______ /\ ___\ /\ __ \ /\ __ \ /\ \ /\ ___\ /\__ _\ /\ __ \ /\ == \ /\ ___\ \ \ \____ \ \ \/\ \ \ \ \/\ \ \ \ \____ \ \___ \ \/_/\ \/ \ \ \/\ \ \ \ __< \ \ __\ \ \_____\ \ \_____\ \ \_____\ \ \_____\ \/\_____\ \ \_\ \ \_____\ \ \_\ \_\ \ \_____\ \/_____/ \/_____/ \/_____/ \/_____/ \/_____/ \/_/ \/_____/ \/_/ /_/ \/_____/ ``` CoolStore Website is a containerised microservices application consisting of services based on .NET Core, NodeJS and more running on Service Mesh. It demonstrates how to wire up small microservices into a larger application using microservice architectural principals. Read [documentation](https://vietnam-devs.github.io/coolstore-microservices) for more information. The business domain is inspired from [CoolStore project](https://github.com/jbossdemocentral/coolstore-microservice) by [JBoss Demo Central](https://github.com/jbossdemocentral) and [Red Hat Demo Central](https://gitlab.com/redhatdemocentral). > Currently, we're working on [practical-dapr project](https://github.com/thangchung/practical-dapr) which uses and leverages [Dapr](https://github.com/dapr/dapr) and [Tye](https://github.com/dotnet/tye) from Microsoft to run CoolStore website without need Docker, Docker-compose, and Helm chart for running on localhost and deploying to Kubernetes platform. If you are interested in, please come over [that link](https://github.com/thangchung/practical-dapr)! Check out my [blog](https://medium.com/@thangchung) or say hi on [Twitter](https://twitter.com/thangchung)! ## Try it online [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/vietnam-devs/coolstore-microservices) > Usage with careful: The project is in development mode so that a lot of things shall change due to .NET Core 3.x upgrading. ## Public presentation - [Service Mesh on AKS, the future is now - Microsoft Build event in May 2019](https://mybuild.techcommunity.microsoft.com/sessions/77172?source=TechCommunity) - [From Microservices to Service Mesh - DevCafe event in July 2018](https://www.slideshare.net/ThangChung/from-microservices-to-service-mesh-devcafe-event-july-2018) - [Service Mesh for Microservices- Vietnam Mobile Day event in June 2018](https://www.slideshare.net/ThangChung/service-mesh-for-microservices-vietnam-mobile-day-june-2017) - [Avoid SPOF in Cloud-native Apps - Vietnam Web Summit event in December 2018](https://www.slideshare.net/ThangChung/avoid-single-point-of-failure-in-cloud-native-application) # Table of contents - [Screenshots](https://github.com/vietnam-devs/coolstore-microservices#screenshots) - [Business Context](https://github.com/vietnam-devs/coolstore-microservices#business-context) - [OS, SDK, library, tooling and prerequisites](https://github.com/vietnam-devs/coolstore-microservices#os-sdk-library-tooling-and-prerequisites) - [High level software architecture](https://github.com/vietnam-devs/coolstore-microservices#high-level-software-architecture) - [Installation](https://github.com/vietnam-devs/coolstore-microservices#installation) - [µService development](https://github.com/vietnam-devs/coolstore-microservices#µmicroservice-development) - [Open API](https://github.com/vietnam-devs/coolstore-microservices#open-api) - [CI/CD](https://github.com/vietnam-devs/coolstore-microservices#ci-cd) - [Service mesh](https://github.com/vietnam-devs/coolstore-microservices#service-mesh) - [Contributing](https://github.com/vietnam-devs/coolstore-microservices#contributing) - [Contributors](https://github.com/vietnam-devs/coolstore-microservices#contributors) - [Licence](https://github.com/vietnam-devs/coolstore-microservices#licence) ## Screenshots ### Home page ![home-page](assets/images/ui-screen-1.PNG?raw=true) ### Shopping Cart page ![cart-page](assets/images/ui-screen-2.PNG?raw=true) ## Business Context ### Conceptual Model ![conceptual-model](docs/.vuepress/public/conceptual-model.png?raw=true) ### Event Storming ![es-bc](docs/.vuepress/public/es-bounded-context.png?raw=true) ### Context Map ![es-context-map](docs/.vuepress/public/es-context-map-2.png?raw=true) ## OS, SDK, library, tooling and prerequisites ### Infrastructure - **`Windows 10`** - the OS for developing and building this demo application. - **[`Windows subsystem Linux - Ubuntu OS`](https://docs.microsoft.com/en-us/windows/wsl/install-win10)** - the subsystem that helps to run easily the bash shell on Windows OS. - **[`Docker for desktop (Kubernetes enabled)`](https://www.docker.com/products/docker-desktop)** - the easiest tool to run Docker, Docker Swarm and Kubernetes on Mac and Windows. - **[`Kubernetes`](https://kubernetes.io) / [`AKS`](https://docs.microsoft.com/en-us/azure/aks)** - the app is designed to run on Kubernetes (both locally on "Docker for Desktop", as well as on the cloud with AKS). - **[`helm`](https://helm.sh)** - the best package manager to find, share, and use software built for Kubernetes. - **[`istio`](https://istio.io)** - application works on Istio service mesh. - **[`linkerd2`](https://github.com/linkerd/linkerd2)** - a service mesh for Kubernetes and beyond. ### Back-end - **[`.NET Core 3.x`](https://dotnet.microsoft.com/download)** - .NET Framework and .NET Core, including ASP.NET and ASP.NET Core. - **[`IdentityServer4`](https://identityserver.io)** - the Identity and Access Control solution for .NET Core. - **[`gRPC`](https://grpc.io)** - a high-performance, open-source universal RPC framework. - **[`Redis`](https://github.com/StackExchange/StackExchange.Redis)** - General purpose redis client. - **[`NEST`](https://github.com/elastic/elasticsearch-net)** - Elasticsearch.Net & NEST. ### Front-end - **[`nodejs 10.x`](https://nodejs.org/en/download)** - JavaScript runtime built on Chrome's V8 JavaScript engine. - **[`typescript`](https://www.typescriptlang.org)** - a typed superset of JavaScript that compiles to plain JavaScript. - **[`create-react-app`](https://facebook.github.io/create-react-app)** - a modern web app by running one command. ## High level software architecture ![Architecture Screenshot](assets/images/arch-diagram.png?raw=true 'Architecture Diagram') There are several individual µservices and infrastructure components that make up this app:
No. Service Description Source Endpoints
1. IdP (.NET Core + In-memory database)
 Uses IdentityServer4 to authentication with OAuth 2.0 and OpenID Connect for the whole stack code dev and staging
2. GraphQL server (.NET Core)
 The GraphQL server for backoffice application code dev and staging
3. OpenApi (.NET Core + envoy-proxy)
 The OpenAPI which generated from gRPC contract files, hosted in OpenAPI format, and used envoy-proxy to proxy it code dev and staging
4. Web (PWA - Vuejs + Node.js)
 Frontend based on vuejs and Node.js code dev and staging
5. Backoffice (React + TypeScript + Apollo-client)
 The back office application for management business entities in the system code dev and staging
6. Catalog (Node.js + TypeScript + Mongo)
 Serves products and prices for retail products code dev
7. Cart (.NET Core + MySQL)
 Manages shopping cart for each customer code dev
8. Inventory (.NET Core + MySQL)
 Serves inventory and availability data for retail products code dev
9. Rating (Node.js + TypeScript + Mongo)
 Runs for rating products code dev
## Installation ### Development environment #### Up and running with `Docker` and `docker compose` ```bash $ docker-compose -f docker-compose.yml -f docker-compose.dev.yml build $ docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d ``` See https://vietnam-devs.github.io/coolstore-microservices/development/#up-and-running-with-docker-and-docker-compose ### Staging and Production environments #### Up and Running on `Azure Kubernetes Service` (`AKS`) See https://vietnam-devs.github.io/coolstore-microservices/development/#up-and-running-manually-on-docker-for-desktop-and-aks ## µService development Guidance for developing µService can be found at [Clean Domain-Driven Design in 10 minutes](https://medium.com/@thangchung/clean-domain-driven-design-in-10-minutes-6037a59c8b7b) ![µService Screenshot](assets/images/miniservice-development.PNG?raw=true 'Microservice') ## Open API ![OpenAPI Screenshot](assets/images/open-api.png?raw=true 'OpenAPI') https://documenter.getpostman.com/view/4847807/SVmvUeZv?version=latest#9f5ed7e4-e855-46e5-a42d-64edb31bc1cb ## CI/CD ![Lift and Shift](assets/images/lift-and-shift.PNG?raw=true 'liftandshift') ## Service mesh [`istio`](https://istio.io) provide a wealth of benefits for the organizations that use them. There’s no denying, however, that adopting the cloud can put strains on DevOps teams. Developers must use microservices to architect for portability, meanwhile operators are managing extremely large hybrid and multi-cloud deployments. Istio lets you connect, secure, control, and observe services. ### Distributed tracing ![DAG chart](assets/images/jaeger-dag-1.PNG?raw=true 'DAG') ![Trace chart](assets/images/jaeger-trace-1.PNG?raw=true 'Trace') ### Metrics ![Metrics chart](assets/images/grafana-ui-1.PNG?raw=true 'Metrics') ## Contributing 1. Fork it! 2. Create your feature branch: `git checkout -b my-new-feature` 3. Commit your changes: `git commit -am 'Add some feature'` 4. Push to the branch: `git push origin my-new-feature` 5. Submit a pull request :p ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key))

Thang Chung

💻 💬 📖 👀 🚇 🚧


Phuong Le

💻 📦 🚇


Phi Huynh

🤔 🚇


Thinh Nguyen

💻 🚧


Stuart Leeks

📖

## Licence Code released under [the MIT license](https://github.com/vietnam-devs/coolstore-microservices/blob/master/LICENSE).