beckn / beckn/policy-admin-api

[C4GT] Create Smart Policy Infrastructure for Open Networks

Open
#19 13 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
JavaScript
Stars
3
Forks
4
PR merge metrics
No merged PRs in 30d

Description

# Project Details
[Beckn protocol](https://becknprotocol.io/) 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](https://ondc.org/) (ONDC), [Namma Yatri](https://nammayatri.in/) at Bangalore, [Kochi Open Mobility Network](https://openkochi.net/) (KOMN), [Unified Health Interface](https://uhi.abdm.gov.in/) (UHI), etc.

Beckn protocol allows the creation of smart cities.

Smart cities will have hundreds and thousands of such platforms across multiple domains all interconnected and transacting with each other on a common transaction fabric. Beckn protocol allows transactions to become interoperable across platforms and across domains where buyers on one platform can transact with sellers on a different platform.

Such a setup allows greater choice and a seamless experience for the consumer, and more autonomy to the seller. However, It is not enough for buyers and sellers to have more access to each other and transact. There are other real-world factors that affect the quality of transactions between buyers and sellers, for example,

- Weather
- Traffic
- Local Policies

Platforms and businesses must take into account such factors when providing services to their users.

Beckn protocol allows smart policies and information updates to be published and broadcast to platforms on an open network.

Such policies can be read by these platforms and dynamically applied to ongoing transactions.

Information update like diversions, accident detection, air quality index, windspeed, rain, even regulatory updates like odd-even rules, quarantine zones, restricted products, price caps, etc can be transmitted across open networks as smart policies.Such smart policies allow Businesses to provide better service quality, be more transparent to their customers

Smart city planners, policymakers can quickly create, deploy and test policies and gather feedback in an agile manner to help formulate better policies and plans for the future.
## Features to be implemented
- Policy Administration UI
- Policy Management APIs
- Standard Policy API for Gateway
- Policy Registry API

## What exists
- Beckn protocol specifications at : https://github.com/beckn/protocol-specifications
- Smart Cities Experience Center Demonstration : https://experience-guide.becknprotocol.io/cities

## What needs to be built
- Beckn protocol Policy API specification
- A policy administration infrastrucuture
## Learning Path
### Complexity
Medium

### Skills Required
- React JS
- NodeJS
- Open API 3.0
- JSON Schema
- 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
- Policies when published must be available on open-source reference implementations for mobility, retail and other sectors

## Out of Scope
- NA

## Milestones
- Understanding beckn protocol
- Identifying and cataloging policy use cases across multiple sectors like mobility, retail, logistics, healthcare etc
- Developing standard policy schema
- Encoding various policies on a standard policy schema
- Policy Registry Setup
- Policy API implementation across multiple applications

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Beckn protocol specifications and catalog policy use cases across mobility, retail, logistics and healthcare. Contact the listed project setup and guidance mentors for repository and product setup instructions. Done means a standard policy schema, registry and APIs are implemented so published policies are available to open-source reference implementations across sectors.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, mongodb, nodejs, openapi, react
Domain
api, backend, databases, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.