eShopOnAbp

eShopOnAbp

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

⚠️ Important Notice
This project, "eshoponabp," is outdated. It served as a reference project for microservice architecture using the ABP Framework, but we now recommend using the ABP Microservice Solution Template for new projects.

The new template offers a modernized and officially supported starting point for building microservices with ABP. Please consider transitioning to the new template for the latest features and improvements.

Issues

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

How to Run?

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

Requirements

• .NET 6.0 Runtime (required for TYE)
• .NET 9.0 SDK
• Docker
• Yarn v1.20+(not v2) or npm v6+ (already installed with Node)

Instructions

• Clone the repository ( eShopOnAbp )

• Install Tye (follow these steps)

  dotnet tool update --global Microsoft.Tye --prerelease
  

• 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 the 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 to SSL, developer certificate creation may have failed because of Powershell issues regarding authorization. Check the PowerShell script running configuration and set the policy for your local machine as follows:

  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 certificate is expired, you'll see the following error:

Generating a new certificate will fix that issue. To generate a 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 ✔️

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

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