Name: beckn-qr-code-generator
Title: "Getting Acquainted with Beckn"
Labels: C4GT Community

---

Description

Goals:

Test out the following link:
Experience center (https://retail-app.becknprotocol.io/) walkthrough and understand the corresponding API calls to the Beckn network for each user action.

Expected Outcome:
Understanding Beckn API calls for each user action made on the BPP application. Overall how QR code was implemented in the flow.

Acceptance Criteria:
A document explaining the user actions with their corresponding API calls and the sequence diagram of API calls.

---

Project:
Beckn

Organization Name:
Beckn Open Collective

Domain:
Others

Tech Skills Needed:
• Basic understanding of Beckn
• Basic documentation

Mentor(s)
Faiz Mohammed

Complexity
Low

Issue Title: Deploy QR SDK Platform on Vercel

Issue Description:

Objective:
The goal of this issue is to deploy the QR SDK platform on Vercel to enable a seamless QR code generation and interpretation workflow.

Context:
The QR SDK platform is a critical component of our application that facilitates QR code generation and interpretation. Deploying it on Vercel will not only ensure reliability and scalability but also simplify the deployment process.

Tasks:

1. Setup Vercel Account: If not already done, set up an account on Vercel (https://vercel.com/) and ensure you have the necessary permissions to deploy projects.

2. Repository Configuration: Verify that the QR SDK platform repository is configured correctly for deployment on Vercel. Ensure that the necessary environment variables and configurations are in place.

3. Deployment Configuration: Create a deployment configuration for Vercel that specifies the deployment environment, build settings, and any required dependencies.

4. Continuous Integration: Implement a CI/CD pipeline that automatically deploys updates to the QR SDK platform whenever changes are pushed to the repository.

5. Testing: Thoroughly test the deployed QR SDK platform on Vercel to ensure it functions as expected. Test various QR code generation and interpretation scenarios.

6. Documentation: Update the project's documentation to reflect the new deployment location on Vercel. Provide clear instructions on how team members can access and use the platform.

Acceptance Criteria:

• The QR SDK platform is successfully deployed on Vercel.
• The platform functions as expected, with no critical issues or errors.
• The CI/CD pipeline is set up and automatically deploys updates to Vercel when changes are pushed to the repository.
• Documentation is updated to reflect the Vercel deployment and usage instructions.

Project Details

Beckn protocol is a set of open specifications aimed to create a common language, that is machine-readable and enables interoperability for economic transactions between disparate platforms of any size and form - be it a cab reservation, or booking a stay, or confirming a doctor’s appointment, and many more. Thus it enables the creation of inclusive and equitable open networks offering a multitude of choices to the citizens, while at the same time negating the dependence on intermediaries to freely operate and generate economic transactions of value. It is akin to what SMTP is to E-mails or HTTP is to the Internet.

Since its inception in 2019 as a set of specifications, Beckn has been adopted across geographies in sectors such as mobility, retail, hyperlocal logistics, healthcare, skills, agriculture sectors, etc. Few notable examples of open networks built on the Beckn protocol are Open Network for Digital Commerce (ONDC), Namma Yatri at Bangalore, Kochi Open Mobility Network (KOMN), Unified Health Interface (UHI), etc.

The Beckn QR project aims at creating a platform that generates various types of interoperable beckn-compliant QR codes (similar to UPI QR codes) representing various objects and events on a beckn-enabled network. Scanning of such QR codes by beckn-aware applications can potentially trigger instantaneous catalog import, product marketing and discovery, quote fetching, single-click orders, and status updates through beckn APIs. For example, a user on a beckn-enabled consumer application can scan a QR code printed outside a grovery store and instantaneously subscribe to daily grocery delivery. Furthermore, through these QR codes, a user can pick up an order on one application import it into another application by scanning the QR code and track the order status from there.

Features to be implemented

• QR code generation UI
• QR code scanner and interpreter

What exists

• Beckn protocol sandbox at : https://github.com/beckn/beckn-sandbox
• Beckn protocol specifications at : https://github.com/beckn/protocol-specifications
• Beckn protocol tech overview on Youtube : https://www.youtube.com/watch?v=7Otfcy37-NE&list=PLBC6c8MLy9uVUIb1BOgdOa8tP4rX6c4aK
• Experience center demonstrating porting of an order from one app to another via interoperable QR codes : https://experience-guide.becknprotocol.io/himalayas

What needs to be built

• Beckn protocol specifications for Rating and Reputation Infrastructure
• Implementation of Rating and Reputation Specification on a Blockchain Infrastructure

Learning Path

Complexity

Medium

Skills Required

• Open API 3.0
• JSON Schema
• NodeJS
• JavaScript
• ReactJS
• MongoDB

Name of Mentors:

Product Understanding

• @ravi-prakash-v
• @faizmagic

Protocol Specification Design

• @ravi-prakash-v

Project Setup and Guidance

• @faizmagic
• @hemant-eminds
• @nikhil2128
• @ujjwal502

Product Setup

• @nikhil2128
• @ujjwal502

Product Architecture

• @ravi-prakash-v
• @nikhil2128

Frontend Development

• @ujjwal502

Backend Development

• @nikhil2128
• @emindsajay
• @zoyaashik

Deployment and Devops

• @prasad-takale-eminds

Testing and QA

• @SushanthKJ

Project size

8 Weeks

Project Setup Guide

To set up this project, please connect with the Project Setup and Guidance mentor for this project and follow their instructions

Product Set Up

To set up this project, please connect with the Product Setup and Guidance mentor for this project and follow their instructions

Acceptance Criteria

• Successful generation and import of QR code data into a beckn-enabled application

Out of Scope

• NA

Milestones

• Understanding beckn protocol
• Beckn QR Product Requirements Definition
• System Architecture
• QR code service APIs
• QR code management UI
• QR code scanner UI sdk and interpretation logic
• Demonstration of a live QR code scan

Name: Beckn QR
Title: "Setting up development environment"
Labels: C4GT Community

---

Description

Problem:
Development environment not set up.

Goals
• Development environment should be set up and tested for the below requirements.
o Open API 3.0
o JSON Schema
o NodeJS
o JavaScript
o ReactJS
o MongoDB
• A basic “Hello World” program to be created and executed successfully.
• Database access and CRUD operations to be performed.
• Any required plugin should be installed and tested.
• Postman to be installed and tested with dummy APIs. (https://dummyjson.com/)

Expected Outcome
• Development environment up and running without any errors.

Acceptance Criteria
• Sample program runs without error.
• Database is accessible and can be used for CRUD operations.

---

Project
Beckn

Organization Name
Beckn Open Collective

Domain
Others

Tech Skills Needed:
• Basic level software installation
• Basic level programming

Mentor(s)
Ravi Prakash

Complexity
Low

Implement Beckn Search and Catalog Management APIs

Description

Background:
As part of enhancing our Beckn protocol implementation, we need to focus on fetching catalogs using the Beckn search mechanism. This will involve encoding a selected provider as a search request and then saving the resulting JSON data. Additionally, we need to implement functionalities to generate QR codes based on the saved data.

Objectives:

• Implement the generateSearchRequest API to create a search request body for a given provider ID fetched from the last on_search response.
• Develop the saveRequest API to save the output of generateSearchRequest as a JSON file and return the URL to the file as a Beckn protocol URL.
• Create the generateQR API to take the output of saveRequest and generate a QR code image.
• Enable the ability to generate a search request for a provider, an item, or a category.

API Specifications

1. generateSearchRequest:

   • Input: provider.id (fetched from the last on_search response)
   • Output: Search request body where message.intent.provider.id is equal to the selected provider ID.

2. saveRequest:

   • Input: Output of generateSearchRequest
   • Output: URL to the saved JSON file as a Beckn protocol URL

3. generateQR:

   • Input: Output of saveRequest
   • Output: QR code image generated based on the provided data

Additional Requirements

• The APIs should be well-documented with clear usage examples.
• Ensure error handling for edge cases, such as missing data or invalid inputs.
• Implement suitable unit tests for each API to ensure functionality and stability.

Use Cases

• The implemented APIs should allow users to easily generate search requests for providers, items, or categories.
• Users should be able to save these requests as JSON files and obtain URLs for sharing.
• QR code generation should provide a visual representation of the saved request for easy sharing and scanning.

Note

This issue should track the development and implementation of the specified APIs, including their documentation and unit tests. Once completed, the new functionality will enhance our Beckn protocol implementation by providing efficient search, catalog management, and sharing capabilities.