ravipinto / ondc-sdk

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

User Manual

A detailed user manual for the buyer reference app is available here

Introduction

This repo is ONDC Buyer App with microservice architecture which contains

  • protocol layer(python)
  • client API layer (node js)
  • front app(react) being served via nginx
  • ancillary API (python) - flask apis for utilities like mapmyindia, knowlarity composed together with docker-compose.yaml

for whom

  • wants to refer the buyer app
  • wants the same setup to be available in their infra
  • pick any component of it and use separately

HOW to run locally

  1. Make sure you've pulled all sub-directories, CMD
  2. You need a ngrok instance to be running locally so you can publish yourself to the internet
  3. Install ngrok
    1. brew install --cask ngrok
ngrok http 5555
  1. Copy the url to the clipboard and paste in BAP_URL and PROTOCOL_BASE_URL in .env-local
  2. Now we need to setup the docker-compose env file
  3. Pick the .env-local file and ask the admin for keys that need to replaced
  4. Get firebase-service-account.json(this can be fetched from firebase console too) and juspay.pem from admin and place them under the path biap-client-node-js/config/dev
  5. Run
docker-compose -f docker-compose-for-local.yaml --env-file .env-local up -d
  1. Open http://localhost

About

License:MIT License


Languages

Language:Shell 53.5%Language:Python 46.5%