Git Product home page Git Product logo

bap-boilerplate-sdk's Introduction

BAP-Boilerplate-SDK

This is an open-source generic SDK that allows any beckn-enabled consumer application to be built quicly

bap-boilerplate-sdk's People

Contributors

ravi-prakash-v avatar

Watchers

 avatar  avatar

Forkers

sandeepb3

bap-boilerplate-sdk's Issues

Build Search Component which will search by item name


Description

The Search component should provide a facility to search items by name. It should fetch all the items which contains the search keyword from BPPs.

Goals

  • Buyer should be able to fetch all the items searched by keyword.

Expected Outcome

Satisfy the above mentioned goals.

Acceptance Criteria

  1. There should be a input box where Buyer can put keyword to search for.
  2. On clicking search action button, it should fetch the items containing the keyword in their name or description from BPPs

Product Name

Beckn

Project Name

BAP-Boilerplate-SDK

Domain

Culture and Tourism

Tech Skills Needed:

NodeJS, ReactJS

Mentor(s)

  • nikhil2128

Complexity

Medium

Category

  • UI/UX/Design
  • Integrations
  • Features
  • Deployment
  • Test

Sub Category

  • API
  • Database
  • Analytics
  • Frontend
  • Backend

Build API to create catalog


Description

This API should provide a facility to add catalog with details like title, description, price, icon, category, quantity. Seller should be able to add catalog using this api.

Goals

  • Seller should be able to add catalog.

Expected Outcome

Satisfy the above mentioned goals.

Acceptance Criteria

  1. There should be a input fields where Seller can details about the catalog
  2. On clicking add action button, it should add the catalog.

Product Name

Beckn

Project Name

BPP-Boilerplate-SDK

Domain

Culture and Tourism

Tech Skills Needed:

NodeJS, ReactJS

Mentor(s)

  • nikhil2128

Complexity

Medium

Category

  • UI/UX/Design
  • Integrations
  • Features
  • Deployment
  • Test

Sub Category

  • API
  • Database
  • Analytics
  • Frontend
  • Backend

Getting Acquainted with BECKN

Name: BAP-Boilerplate-SDK
Title: "Getting Acquainted with BECKN"
Labels: C4GT Community


Description

Goals

Expected Outcome
Understanding of BECKN API calls for each user action made on the BAP application.

Acceptance Criteria
• 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

Setting up development environment

Name: BAP-Boilerplate-SDK
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 below requirements.
o Open API 3.0
o JSON Schema
o NodeJS
o JavaScript
o React Native
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)
Faiz Mohammed

Complexity
Low

[C4GT] Develop UI + Backend SDK Framework for BAPs

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

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.