rohanrajpal/bap-reference-app

Instructions and files required to deploy this Beckn Application (BAP) or any of its building blocks individually.

Beckn in a Box BAP

This repository contains the instructions and files required to deploy this Beckn Application (BAP) or any of its building blocks individually.

Overview

This BAP comprises of four building blocks: the UI layer, the Beckn protocol client, the Beckn protocol helper and the protocol DTOs.

UI Layer

The UI layer is a Progressive Web Application implemented in vue using the storefront framework. The UI layer interacts with the beckn protocol client to perform operations using the Beckn protocol.

Beckn Protocol Client

The beckn protocol client receives inputs from the UI layer and makes calls using the Beckn protocol to the Beckn network. The beckn protocol client interacts with the protocol layer to get responses (provided via callbacks) from the Beckn network. It is written in kotlin.

Protocol Helper

The protocol helper receives callback responses from the Beckn network and saves them to a mongo database. The beckn protocol client then queries this layer to retrieve the responses. It is written in kotlin.

Protocol DTOs

The protocol-dtos repository contains schema definitions that are used in all 3 building blocks. It is written in kotlin.

Usage

All four building blocks are designed such that they can be used individually or together. Each building block has a docker file that builds the component as a docker image. View the docker usage guide for more details.

Issues/Contributing

For any questions, please don't hesitate to open a new discussion. If you wish to contribute, please feel free to discuss, pick up any issue and implement the bug fix/feature request!