Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[C4GT] Develop UI + Backend SDK Framework for BAPs #1

Open
ravi-prakash-v opened this issue May 20, 2023 · 4 comments
Open

[C4GT] Develop UI + Backend SDK Framework for BAPs #1

ravi-prakash-v opened this issue May 20, 2023 · 4 comments
Labels
good first issue Good for newcomers

Comments

@ravi-prakash-v
Copy link
Contributor

ravi-prakash-v commented May 20, 2023

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 BAP Boilerplate SDK is a generic full-stack NodeJS + React-native SDK that allows developers to quickly beckn-enabled consumer-facing applications (BAPs) via a boilerplate codebase. This consists of a base source-code when complied generates a basic BAP application with all APIs and screens for each state that is encountered during a typical order lifecycle like disovery, ordering, fulfillment and post-fulfillment. Developers can then modify these screens according various UI flowspertaining to different sector-specific experiences like mobility, health, retail, etc

Features to be implemented

  • UI Framework
  • Backend API Framework and Network Interface

What exists

What needs to be built

  • Open-source codebase with installation guide and developer docs
  • Downloadable apk

Learning Path

Complexity

Medium

Skills Required

  • Open API 3.0
  • JSON Schema
  • NodeJS
  • JavaScript
  • React Native
  • MongoDB

Name of Mentors:

Product Understanding

Protocol Specification Design

Project Setup and Guidance

Product Setup

Product Architecture

Frontend Development

Backend Development

Deployment and Devops

Testing and QA

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

  • Demonstration of a mobility transaction through an Android app built on this SDK
  • Demonstration of a retail transaction through an Android app built on this SDK
  • Demonstration of a stay and tourism transaction through an Android app built on this SDK

Out of Scope

  • iOS app

Milestones

  • Understanding beckn protocol
  • Detailed product requirements document
  • UI Framework source-code architecture
  • UI Framework development
  • Backend Framework source-code architecture
  • Backend Framework development
@ravi-prakash-v ravi-prakash-v added the good first issue Good for newcomers label May 20, 2023
@ravi-prakash-v ravi-prakash-v changed the title Create Product Requirement Document [C4GT] Create Product Architecture and Specification May 20, 2023
@ravi-prakash-v ravi-prakash-v changed the title [C4GT] Create Product Architecture and Specification [C4GT] Develop UI + Backend SDK Framework for BAPs May 20, 2023
@ajaman190
Copy link

Hello @ravi-prakash-v and mentors! I'm Aman Kumar, a third-year undergraduate student at IIT Kharagpur. After reviewing the project description, I feel confident in my skills across all the tech stacks mentioned. I'm eager to submit a proposal for it. Could you please guide me on where to begin?

@harshikagoyal14
Copy link

Hello @ravi-prakash-v , I found this project really interesting. I am eager to submit a proposal for it .

@Sumitmaithani
Copy link

👋 Hey @ravi-prakash-v, I'm really looking forward to submitting my proposal for this project! 🚀

@dhirajshettyyy
Copy link

@ajaman190 @harshikagoyal14 @Sumitmaithani, It's great to see your interest in this project, you can make an active contribution via issue creation and by submitting your Pull Requests.

For support from fellow contributors, Join Beckn Open Collective server :https://bit.ly/bocWebInvite

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants