ondc-buyer

Files (5)

• SKILL.md
• README.md · references/
• check-status.ts · scripts/
• generate-keys.ts · scripts/
• register.ts · scripts/

SKILL.md (first lines)

# ONDC Buyer Skill

This skill helps you deploy and manage ONDC (Open Network for Digital Commerce) buyer applications. ONDC is India's digital commerce network enabling buyers to discover and purchase from sellers across multiple platforms.

## What This Skill Does

- **Deploy ONDC Buyer Apps**: Set up the complete buyer reference application
- **Product Discovery**: Search and browse products across ONDC network
- **Shopping Cart**: Manage cart, apply customizations, and handle variants
- **Checkout Flow**: Handle select, init, confirm, and payment flows
- **Order Tracking**: Track orders in real-time with GPS/URL-based tracking
- **Returns & Cancellations**: Process returns, cancellations, and refunds
- **IGM Support**: File and track issues/complaints with sellers

## Architecture Overview

The ONDC Buyer App uses microservice architecture:
- **biap-client-node-js**: Node.js backend API layer
- **biap-app-ui-front**: React web application (served via nginx)
- **py-ondc-protocol**: Python protocol layer for ONDC communication
- **biap-igm-node-js**: Node.js IGM service for issue management
- **biap-bugzilla-service**: Bugzilla integration for ticket management
- **catalog-service**: Catalog indexing and search service

## Prerequisites

Before using this skill, ensure you have:

1. **Docker & Docker Compose** installed
2. **Git** with submodule support
3. **Domain name** or ngrok for public endpoint
4. **Required service accounts**:
   - Firebase (authentication)
   - Juspay or other payment gateway
   - Map My India (location services)
5. **MongoDB** (included in docker-compose)
6. **ONDC Registry Access** (for production deployment)

## Quick Start

### 1. Clone and Initialize

```bash
cd /home/workspace
git clone https://github.com/ONDC-Official/ondc-sdk.git ondc-buyer-app
cd ondc-buyer-app
git submodule init
git submodule update
```

### 2. Generate Cryptographic Keys

```bash
bun /home/workspace/Skills/ondc-buyer/scripts/generate-keys.ts
```

This creates signing and encryption keys required for ONDC registration.

### 3. Configure Environment

```bash
bun /home/workspace/Skills/ondc-buyer/scripts/setup-env.ts \
  --domain "https://buyerapp.example.com" \
  --firebase-key "YOUR_KEY" \
  --juspay-merchant-id "MERCHANT_ID" \
  --mmi-client-id "MMI_CLIENT"
```

### 4. Deploy Locally (Development)

```bash
cd /home/workspace/ondc-buyer-app
docker-compose -f docker-compose-for-local.yaml --env-file .env-local up -d
```

Access the app at `http://localhost` (or your configured domain).

### 5. Register with ONDC

Once deployed, use the registration helper:

```bash
bun /home/workspace/Skills/ondc-buyer/scripts/register.ts \
  --subscriber-url "https://buyerapp.example.com" \
  --signing-key "path/to/signing_public.pem" \
  --crypto-key "path/to/crypto_public.pem"
```

## Common Operations

### Check Application Status

```bash
bun /home/workspace/Skills/ondc-buyer/scripts/check-status.ts
```

Shows the status of all services (client, frontend, protocol, IGM, catalog).

### Search Products

```bash
# Search across ONDC network
bun /home/workspace/Skills/ondc-buyer/scripts/search.ts --query "smartphones" --city "Bangalore"

# Search by category
bun /home/workspace/Skills/ondc-buyer/scripts/search.ts --category "Grocery" --location "110001"

# Get provider details
bun /home/workspace/Skills/ondc-buyer/scripts/search.ts --provider-id "PROVIDER123"
```

### Manage Orders

```bash
# List user orders
bun /home/workspace/Skills/ondc-buyer/scripts/view-orders.ts --user-id "USER123" --limit 10

# Get order details and tracking
bun /home/workspace/Skills/ondc-buyer/scripts/view-orders.ts --order-id "ORDER456"

From ankitjh4/indic-ai-skills, MIT.

More from ankitjh4/indic-ai-skills