How quiknode-labs/qn-guide-examples works
Project type and purpose
• This is a monorepo (“QuickNode Guide Examples”) containing dozens of independent example applications—front-ends, back-ends, CLI tools, smart‐contract demos, bots and scripts—organized by category: AI, QuickAlerts, Streams, base, defi, bitcoin, ethereum, solana, polygon, stacks, tron, etc.
• Each example illustrates how to integrate with QuickNode’s blockchain-as-a-service endpoints, various SDKs, or external APIs.
File structure
• Top-level directories correspond to high-level categories (AI, QuickAlerts, Streams, sample-dapps, etc.).
• Under each category are self-contained subprojects (e.g., “AI/coinbase-ai-agent”, “Streams/dex-metrics-dashboard”, “ethereum/erc-6551”, “solana/explorer-clone-part-1”).
• Typical pattern inside each subproject:
– A package manifest (package.json or analogous)
– Source folder (src or app) containing front-end (React/Next.js/Svelte) code, API routes, CLI scripts or smart-contract configs.
– Config/build artifacts (tsconfig.json, next.config.js, postcss/tailwind configs, hardhat.config.js, foundry.toml).
– Tests or scripts directory.
• There is no single runtime—each module is built and run in isolation, but they share the QuickNode RPC endpoint as the common external service.
README for additional insights
• The root README explains that this is a “collection of example applications from QuickNode’s guides” and points contributors to add per-directory README.md.
Diagramming recommendations
– Blue rectangles for front-ends
– Green for back-ends / scripts
– Orange for smart-contract components
– Purple for external services
Key points to capture in detail
• Monorepo structure with isolated, self-contained example modules
• Shared reliance on QuickNode endpoints and other external APIs
• Variety of technology stacks illustrated by examples
• Clear separation of concerns within each example (UI vs. API vs. contract/test)
• CI/CD or local dev workflows, if present