### Clone and Setup QN Guide Examples Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/TEMPLATE_README.md This snippet demonstrates how to clone the QN Guide Examples monorepo from GitHub, navigate into the project directory, install necessary npm dependencies, and open the project in VS Code. ```bash git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/ (Update this line with the particular directory) npm install code . ``` -------------------------------- ### Project Setup and Development Commands Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/ethereum/wave-portal-svelte/code/wave-portal-starter-boilerplate/README.md These commands are used to clone the project repository, navigate into the project directory, install dependencies using Yarn, and start the development server. ```shell git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/ethereum/wave-portal-svelte/code/wave-portal-boilerplate yarn yarn dev ``` -------------------------------- ### Local Setup and Execution Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/ethereum/wave-portal-svelte/code/wave-portal-complete/README.md Instructions to clone the repository, install dependencies using yarn, and start the development server. ```shell git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/ethereum/wave-portal-svelte/code/wave-portal-complete yarn yarn dev ``` -------------------------------- ### Run Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/aml-and-cft-compliant-dapp/next-app/README.md Commands to start the Next.js development server using different package managers. This allows for local development and testing of the application. ```bash npm run dev # or yarn dev # or pnpm dev # or bun dev ``` -------------------------------- ### Web Local Development Setup Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/enhanced-apis/NFT-Collection-Explorer/README.md Steps to set up and run the web application for local development. This includes navigating to the web directory, installing dependencies, copying environment variables, and starting the development server. ```bash cd web pnpm i ``` ```bash cp .env.example .env # Open .env and replace YOUR_URL_HERE with your QuickNode Ethereum HTTPS URL ``` ```bash pnpm dev ``` -------------------------------- ### Install Dependencies and Run Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/ethereum/farcaster-frames/README.md Navigates to the project directory, installs Node.js dependencies, and starts the development server. ```bash cd ethereum/farcaster-frames npm install npm run dev ``` -------------------------------- ### Server Setup and Execution Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/Streams/README.md Instructions for setting up and running the Node.js server for the QuickNode Streams example. This includes installing dependencies and starting the server. ```bash ngrok http 3000 npm install node app.js ``` -------------------------------- ### Frontend Setup and Execution Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/Streams/README.md Instructions for setting up and running the React frontend application. This involves navigating to the app directory, installing dependencies, and starting the development server. ```bash cd qs-react-app npm install npm run start ``` -------------------------------- ### Run Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/ethereum-dex-trade-performance-analyzer/README.md Starts the development server using npm, allowing you to view the application in your browser at http://localhost:5173/. ```bash npm run dev ``` -------------------------------- ### Clone and Setup Project Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/ethereum/audit-token-activity/README.md Clones the example repository, navigates to the project directory, installs dependencies, and opens the project in a code editor. This is the initial setup step for the project. ```bash git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/ethereum/audit-token-activity npm install ``` -------------------------------- ### Install Project Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/ethereum-dex-trade-performance-analyzer/README.md Installs all the necessary Node.js dependencies required for the application to run. ```bash npm install ``` -------------------------------- ### QuickNode Website Link Format Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/TEMPLATE_README.md Provides the standard format for creating links to the QuickNode website, including UTM parameters for campaign tracking. ```bash https://www.quicknode.com/?utm_source=qn-github&utm_campaign=&utm_content=sign-up&utm_medium=generic ``` -------------------------------- ### Mobile Expo Local Development Setup Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/enhanced-apis/NFT-Collection-Explorer/README.md Instructions for setting up and running the mobile application using Expo for local development. This involves navigating to the mobile directory, installing npm dependencies, and starting the development server. ```bash cd mobile npm i npm start ``` -------------------------------- ### Install Dev Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/solana/jupiter-jito/README.md Installs development dependencies, specifically the Node.js type definitions for TypeScript. ```bash npm install -d @types/node ``` -------------------------------- ### Install Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/tron/README.md Downloads and installs all the necessary Go dependencies for the project, updating the go.sum file. ```bash go mod tidy ``` -------------------------------- ### Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/solana/authentication/steps.md Starts the development server for the project. This command is used to run the application locally during development. ```bash yarn dev ``` -------------------------------- ### Install Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/solana/authentication/steps.md Installs project dependencies using Yarn. This command is typically run after cloning a project or making changes to the dependency list. ```bash yarn install ``` -------------------------------- ### Running the Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/Streams/dex-metrics-dashboard/README.md Commands to start the Next.js development server using different package managers. This allows for local development and testing. ```bash npm run dev # or yarn dev # or pnpm dev # or bun dev ``` -------------------------------- ### Install Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/solana/jupiter-jito/README.md Installs the necessary project dependencies for Jupiter swaps and Solana interactions, including the Jupiter API, Solana Web3.js, base58 encoding, and dotenv for environment variable management. ```bash npm install @jup-ag/api @solana/web3.js@1 bs58 dotenv ``` -------------------------------- ### Next.js Project Setup Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/aml-and-cft-compliant-dapp/next-app/README.md Information about a Next.js project bootstrapped with create-next-app. It highlights the use of next/font for font optimization and provides links to learn more about Next.js. ```next.js This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. ``` -------------------------------- ### Install Dependencies (npm) Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/AI/solana-mcp/README.md Installs project dependencies using npm. This is a common first step for Node.js projects. ```bash cd AI/solana-mcp npm install ``` -------------------------------- ### Install Dependencies (pnpm) Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/AI/solana-mcp/README.md Installs project dependencies using pnpm. A fast and efficient package manager for Node.js. ```bash cd AI/solana-mcp pnpm install ``` -------------------------------- ### Install Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/courses/solana-basics/final/README.md Installs project dependencies using various package managers like npm, yarn, pnpm, or bun. ```bash npm install # or yarn # or pnpm install # or bun install ``` -------------------------------- ### Install Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/solana/web3.js-2.0/optimized-tx/README.md Installs the necessary dependencies for the SDK by navigating to the 'web3.js-2.0' folder and running npm install. ```bash cd web3.js-2.0 npm install ``` -------------------------------- ### Install Dependencies (bun) Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/AI/solana-mcp/README.md Installs project dependencies using bun. A modern JavaScript runtime with a built-in package manager. ```bash cd AI/solana-mcp bun install ``` -------------------------------- ### Run Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/courses/solana-basics/final/README.md Starts the development server to run the application locally. The application will be accessible at http://localhost:3000. ```bash npm run dev # or yarn dev # or pnpm dev # or bun dev ``` -------------------------------- ### Basic Robot.txt Configuration Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/Streams/wallet-allowance-checker-app/public/robots.txt A fundamental robot.txt file that allows all user-agents to crawl all paths. This is a common starting point for many websites. ```robotstxt User-agent: * Disallow: ``` -------------------------------- ### Development Commands by Framework Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/CLAUDE.md Commands used to start development servers and watch for file changes, facilitating a rapid development workflow. These commands often include hot-reloading capabilities. ```bash # Next.js npm run dev # Uses: next dev # React npm start # Uses: react-scripts start # Vite npm run dev # Uses: vite # Node.js with TypeScript npm run dev # Uses: nodemon (with TypeScript watching) ``` -------------------------------- ### Basic Robot.txt Configuration Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/enhanced-apis/token_balance_app/public/robots.txt A fundamental robot.txt file that allows all user-agents to crawl all paths. This is a common starting point for many websites. ```robotstxt User-agent: * Disallow: ``` -------------------------------- ### Basic Robot.txt Configuration Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/Streams/qs-react-app/public/robots.txt A fundamental robot.txt file that allows all user-agents to crawl all paths. This is a common starting point for many websites. ```robotstxt User-agent: * Disallow: ``` -------------------------------- ### Install Project Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/crypto-portfolio-tracker-with-the-crypto-market-data-api/README.md Installs all the necessary Node.js dependencies required for the crypto portfolio tracker application to run. ```bash npm install ``` -------------------------------- ### Navigate to Example Directory Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/courses/solana-basics/final/README.md Changes the current directory to the specific example folder within the cloned repository. ```bash cd courses/solana-basics/final ``` -------------------------------- ### Install Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/ethereum/blink-starter-monad/README.md Navigates into the project directory and installs the necessary Node.js dependencies. ```bash cd ethereum/blink-starter-monad && npm install ``` -------------------------------- ### Install Dependencies Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/solana/explorer-clone-part-1/starter/README.md Installs the necessary project dependencies using either npm or yarn. ```bash npm install # or yarn install ``` -------------------------------- ### Clone Example Monorepo Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/ethereum/erc-20/README.md Clones the qn-guide-examples repository, navigates to the ERC20 project directory, and opens it in VS Code. This is the initial setup step for the project. ```bash git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/ethereum/erc-20 code . ``` -------------------------------- ### Clone Example Monorepo Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/binance/bep20/README.md Clones the qn-guide-examples repository and navigates to the BEP20 project directory. This is the initial step to set up the project environment. ```bash git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/binance/bep20 ``` -------------------------------- ### Clone and Setup Project Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/ethereum/explorer/README.md Clones the example monorepo, navigates to the explorer project directory, and opens it in VS Code. This is the initial setup step for the block explorer project. ```bash git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/ethereum/explorer code . ``` -------------------------------- ### Run Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/courses/solana-basics/progress/README.md Starts the development server to view the example application, typically accessible at http://localhost:3000. ```bash npm run dev # or yarn dev # or pnpm dev # or bun dev ``` -------------------------------- ### Install Dependencies (yarn) Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/AI/solana-mcp/README.md Installs project dependencies using yarn. An alternative package manager for Node.js projects. ```bash cd AI/solana-mcp yarn install ``` -------------------------------- ### Next.js Page Structure Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/Streams/dex-metrics-dashboard/README.md Example of a basic Next.js page file structure, indicating where to start editing the application. ```javascript // Modify app/page.js to edit the page ``` -------------------------------- ### Get Transaction Receipts By Address Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/enhanced-apis/NFT-Collection-Explorer/scripts/README.md Retrieves transaction receipts associated with a given address. This example demonstrates how to fetch transaction data. ```bash node getTransactionReceiptsByAddress.js ``` -------------------------------- ### Run Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/solana-staking-ui/README.md Commands to start the Next.js development server using different package managers. ```bash npm run dev # or yarn dev # or pnpm dev # or bun dev ``` -------------------------------- ### Install TypeScript and ts-node Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/ethereum-dex-trade-performance-analyzer/README.md Installs TypeScript and ts-node globally, making TypeScript available across all projects. ```bash npm install -g typescript ts-node ``` -------------------------------- ### Run Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/crypto-portfolio-tracker-with-the-crypto-market-data-api/README.md Starts the Vite development server, allowing you to preview the crypto portfolio tracker application locally. ```bash npm run dev ``` -------------------------------- ### Start Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/coinbase-x402/README.md Starts the development server for the x402 video paywall application. ```bash npm run dev ``` -------------------------------- ### Clone Example Monorepo Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/solana/sol-get-tokens/README.md Clones the QuickNode guide examples repository and navigates to the specific project directory for Solana token retrieval. ```bash git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/solana/sol-get-tokens ``` -------------------------------- ### Project Structure Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/sample-dapps/solana-staking-ui/README.md Overview of the project's directory structure, highlighting key directories like app, components, context, hooks, and utils. ```bash src/ ├── app/ │ ├── page.tsx │ └── layout.tsx │ └── api/ │ └── balance/ │ │ └── route.ts # Get wallet SOL balance │ └── stake/ │ │ └── fetch/route.ts # Get a wallets' staking accounts │ │ └── generate/route.ts # Generate staking accounts │ └── transaction/ │ └── confirm/route.ts # Confirm a transaction └── components/ ├── stake/ # Various staking components └── [supporting components] └── context/ # Wallet connect context └── hooks/ # Is wallet connected hook └── utils/ # Is wallet connected hook ├── solana/ # Solana staking and account utils └── config.ts # Network settup └── constants.ts ``` -------------------------------- ### Run Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/solana/explorer-clone-part-1/starter/README.md Starts the Next.js development server to view the application locally. ```bash npm run dev # or yarn dev ``` -------------------------------- ### Example Agent Interaction: Get Wallet Balance Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/AI/evm-mcp-server/README.md An example prompt for an LLM agent using the EVM MCP Server to retrieve the balance of a specific Ethereum address. ```plaintext Give the balance of the 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 address on Ethereum ``` -------------------------------- ### Clone Example Monorepo and Navigate Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/stacks/stacks-nft/README.md Clones the qn-guide-examples repository and changes the directory to the Stacks NFT project. This is the initial setup step. ```bash git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/stacks/stacks-nft ``` -------------------------------- ### Run Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/solana/explorer-clone-part-3/starter/README.md Starts the Next.js development server to view the application locally. ```bash npm run dev # or yarn dev ``` -------------------------------- ### Clone Example Monorepo and Setup Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/ethereum/erc-6551/README.md Clones the example monorepo, navigates to the ERC-6551 directory, installs project dependencies, and sets up the .env file for RPC URL and private key. ```bash git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/ethereum/erc-6551 code . npm install # Create .env file # RPC_URL= # PRIVATE_KEY= ``` -------------------------------- ### Clone Example Monorepo and Install solc Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/ethereum/ABI/README.md Clones the qn-guide-examples repository, navigates to the abi directory, and installs the Solidity compiler (solc) globally. This is the first step to obtaining a smart contract's ABI. ```bash git clone https://github.com/quiknode-labs/qn-guide-examples.git cd qn-guide-examples/ethereum/abi code . npm i -g solc ``` -------------------------------- ### Build Commands by Framework Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/CLAUDE.md Common build commands used across different frontend and backend frameworks within the repository. These commands are essential for compiling and preparing applications for deployment. ```bash # Next.js projects (most common) npm run build # Uses: next build # React projects npm run build # Uses: react-scripts build # Vite projects npm run build # Uses: tsc && vite build # TypeScript only npm run build # Uses: tsc -p . ``` -------------------------------- ### Run Development Server Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/courses/solana-basics/starter/README.md Starts the development server for the project, allowing you to view the application in your browser. The application will typically be available at http://localhost:3000. ```bash npm run dev ``` ```bash yarn dev ``` ```bash pnpm dev ``` ```bash bun dev ``` -------------------------------- ### Example Agent Interaction: Get Gas Prices Source: https://github.com/quiknode-labs/qn-guide-examples/blob/main/AI/evm-mcp-server/README.md An example prompt for an LLM agent using the EVM MCP Server to check current gas prices on Ethereum and evaluate if it's a good time to transact. ```plaintext Analyze the current gas prices on Ethereum, is it a good time to use the chain? ```