Giter VIP home page Giter VIP logo

eshop's Introduction

EShop

ABP version NuGet NuGet Download GitHub stars

An abp application module group that provides basic e-shop service.

Online Demo

We have launched an online demo for this module: https://eshop.samples.easyabp.io

Installation

  1. Follow the document to install the dependent PaymentService module.

  2. Install the following NuGet packages. (see how)

    • EasyAbp.EShop.Application
    • EasyAbp.EShop.Application.Contracts
    • EasyAbp.EShop.Domain
    • EasyAbp.EShop.Domain.Shared
    • EasyAbp.EShop.EntityFrameworkCore
    • EasyAbp.EShop.HttpApi
    • EasyAbp.EShop.HttpApi.Client
    • (Optional) EasyAbp.EShop.MongoDB
    • (Optional) EasyAbp.EShop.Web

    The above packages are integration packages containing the necessary sub-modules. Please install packages of each sub-module separately if you are using microservices. For example: install only the EasyAbp.EShop.Products.Application package.

  3. Add DependsOn(typeof(EShopXxxModule)) attribute to configure the module dependencies. (see how)

  4. Add builder.ConfigureEShop(); to the OnModelCreating() method in MyProjectMigrationsDbContext.cs.

  5. Add EF Core migrations and update your database. See: ABP document.

Basic Usage

  • Create a Store (optional)

    • EShop supports multi-store, it provides a default store, it will be created when you seed the initial data. (learn more about ABP Data Seeding)
    • Use the store management page to create a new store.
  • Define a Product Group (optional)

    • Product group is used to classify different types of products, so we can customize different behavior for them, for example, products of the "GiftCard" product group could automatically send the card number and password to the customer's mailbox.
    • EShop provides a default product group.
    • Refer to the configuration of the default product group and define a new product group.
  • Create a Product

    • Use the product management page to create new a product.
    • Click the "SKU" item in the actions button of the product you created and then create an SKU.
  • Place an Order (We have not yet provided UI for this step.)

    • Use the API /api/e-shop/orders/order (POST) to create a new order.
  • Pay for the Order (We have not yet provided UI for this step.)

    • Wait for the inventory reduction to be completed, get the order and ensure the Order.ReducedInventoryAfterPlacingTime is not null.
    • Use the API /api/e-shop/payments/payment (POST) to create a pending new payment for your order.
      • You can pay for multiple orders at once.
      • You need to decide one of the payment methods provided by the EasyAbp.PaymentService module.
    • Use the API /api/e-shop/orders/order/{id} (GET) get the order, then you can get the "paymentId" in the result.
    • Use the API /api/payment-service/payment/{id}/pay (POST) to complete the payment.
      • "id" is the "paymentId" we got above.
      • Different payment methods require different "extraProperties" for this API. Read the document of the EasyAbp.PaymentService module to learn more.
  • Complete the Order

    • We have not yet provided relevant UI for this action.
    • Use the API /api/e-shop/orders/order/{id}/complete (POST) to complete the order.
      • The customer should have permission to complete the order himself.
      • You need to override the "CompleteAsync" method of the "OrderAppService" if you want to prohibit users from completing orders themselves for some specific product groups but complete them through automated processes.

Advanced Usages

We can customize some features to use EShop in complex application scenarios.

Gift Card Shop

  • When a gift card order is paid, automatically send the card number and password to the customer's mailbox.
  • Automatically set the order status to completed after the mail is sent.
  • Read the article to learn how to implement it. (todo)

Paid Knowledge Market

  • Also use the EasyAbp.SharedResources module.
  • The carrier of knowledge can be articles, pictures, audios, videos, files, streams, etc.
  • When a knowledge order is paid, automatically authorize the customer to access the resources he purchased.
  • Read the article to learn how to implement it. (todo)

Submodules

  • Core modules

    • Orders
    • Payments
    • Plugins
    • Products
    • Stores
  • Plugin modules

    • Baskets
    • Coupons

Roadmap

Todo.

eshop's People

Contributors

gdlcf88 avatar raymmond avatar hueifeng avatar yinchang0626 avatar

Stargazers

Esmail Almarrani avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.