README
¶
Postcode Nigeria SDK — Practical Examples
This directory contains real-world, executable examples demonstrating core, advanced, and AI agent capabilities of the Nigerian Postcode SDK.
Examples Directory
| Example | Focus Area | Description | Command |
|---|---|---|---|
main.go |
End-to-End Tour | Full tour covering local parsing, local simulator, graded lookups (L1-L3), autocomplete, reverse geocoding, AI diagnostics, and agent guardrails. | go run ./examples/main.go |
ai_agent_guardrails/ |
AI Agent Safety | Autonomous logistics dispatcher agent demonstrating session call ceilings, in-memory caching, auto-downgrade to free Level 1, and offline fallback. | go run ./examples/ai_agent_guardrails/main.go |
ai_synthetic_eval/ |
AI Benchmarking | Synthetic address generator and evaluation harness benchmark testing extraction accuracy against noisy Nigerian addresses with landmarks, typos, and format variations. | go run ./examples/ai_synthetic_eval/main.go |
wasm_node/ |
Edge / WebAssembly | Running the zero-dependency compiled WebAssembly binary inside Node.js for sub-millisecond offline validation and geocoding. | node ./examples/wasm_node/demo.js |
address_input_web/ |
Web Client Component | Embedding <nipost-address-input> in an HTML checkout form with smart extraction, 774 LGA centroids, and form submission. |
open ./examples/address_input_web/index.html |
Running All Examples
# 1. Complete SDK tour
go run ./examples/main.go
# 2. Autonomous Agent Guardrails & Caching
go run ./examples/ai_agent_guardrails/main.go
# 3. Synthetic Address Generator & AI Eval Benchmark
go run ./examples/ai_synthetic_eval/main.go
# 4. WebAssembly in Node.js
node ./examples/wasm_node/demo.js
# 5. Web Client Component (Browser Checkout Form)
open ./examples/address_input_web/index.html # or npx serve ./examples/address_input_web
Directories
Click to show internal directories.
Click to hide internal directories.