/eShopOnAbp

Reference microservice solution built with the ABP Framework and .NET, runs on Kubernetes with Helm configuration, includes API Gateways, Angular and ASP.NET Core MVC applications, PostgreSQL and MongoDB databases

Primary LanguageC#MIT LicenseMIT

eShopOnAbp

This project is a reference project for those who want to build microservice solutions with the ABP Framework.

See the announcement post for more info.

Live demo is on https://www.eshoponabp.com/

Issues

Please open issues on the main GitHub repository: https://github.com/abpframework/abp/issues

How to Run?

You can either run in Visual Studio, or using Microsoft Tye. Tye is a developer tool that makes developing, testing, and deploying micro-services and distributed applications easier.

Requirements

  • .NET 7.0+
  • Docker
  • Yarn

Instructions

  • Clone the repository ( eShopOnAbp )

  • Install Tye (follow these steps)

  • Rename .env.example file to .env file and provide PayPal ClientID and Secret.

  • Execute run-tye.ps1

  • Wait until all applications are up!

    • You can check running application from tye dashboard (localhost:8000)
    • Note: If you see all of your applications keep restarting on tye dashboard or tye console, you may be facing ssl certificate issues. To diagnose the problems better, check any application logs. If it is related with SSL, developer certificate creation may have failed because of powershell issues regarding authorization. Check the powershell script running configuration and set policy for your local machine as:
     Get-ExecutionPolicy -list
 Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine

    See Microsoft Powershell documentation for more information.

  • After all your backend services are up, start the angular application:

    cd apps/angular
yarn start

Certificate Expiration

If the cerficiate is expired you'll see following error:

Generating a new certificate will fix that issue. To generate new one,

  • Remove etc/dev-cert/localhost.pfx

  • Manually execute create-certificate.ps1 or re-run solution with run-tye.ps1

Roadmap

Version 1.0

  • New blank micro-service solution ✔️
  • Creating Deployment Scenarios ✔️
  • Creating empty business services ✔️
  • Implementing business logic into services ✔️
    • Payment with PayPal ✔️
    • Basket, Catalog, Order Service ✔️
  • Docker Image creation ✔️
  • Helm deployment for local k8s cluster ✔️
  • Switch Ocelot to Envoy YARP in Public Web gateway ✔️
  • Use gRPC for catalog microservice ✔️
  • Management Side of Services ✔️
  • Administration application (to manage products and orders, with a dashboard) ✔️
  • Deployment to azure k8s ✔️ (https://eshoponabp.com)

Version 2.0

  • Product-detail page on the shopping application (with CMS-kit integration for comments and rating components) ✔️
  • Switch to Keycloak from IdentityServer in AuthServer
  • Re-design authorization/permission management
  • Integrate a new sample microservice written in GoLang (Or python/java)

Documentation

  • We will create an e-book to explain the solution

Current Architecture

eSopOnAbp Phase 1

ABP Community Talks

We've organized a meetup related to this solution. You can watch it here: https://community.abp.io/events/microservice-development-iv7d46ov