Example Hub

A hub of frontend, agent kits, and smart contract examples for BNB Chain developers. Build and innovate with ready-to-use resources.

Table of Contents

• Quick Start
• Example List
• How to Add a New Example
  • Development Setup
  • Steps to Add a New Example
  • Additional Notes
• Feedback

Quick Start

To quickly set up and run a demo locally or kickstart a new project based on an existing demo, use the following command:

npx create-bnb-app@latest --example [example-name]

This command downloads and sets up the specified example (replace [example-name] with an option from the Example List). After setup, navigate to the project directory and follow the example’s README.md instructions to run it.

Example List

Explore a variety of examples for different implementations below. The table includes each example’s name, programming language, description, and tags to help you find what you need quickly.

Name	Language	Description	Tags
python/langchain-chatbot	Python	A chatbot example using LangChain	AI, BSC, opBNB
typescript/eliza-chatbot	TypeScript	A chatbot example using Eliza plugin-bnb	AI, BSC, opBNB

More examples are coming soon—stay tuned for updates!

How to Add a New Example

Contributing a new example is a fantastic way to support the BNB Chain developer community. Follow these steps to ensure your submission is seamless and aligns with the repository’s standards.

Development Setup

To maintain code consistency, install these VS Code extensions before you begin:

• Python Development: We use Black for Python code formatting. Install the Black Formatter..
• TypeScript Development: We use Prettier for formatting TypeScript code. Install Prettier.

Steps to Add a New Example

1. Fork the repository to your GitHub account..
2. Create a feature branch with a descriptive name (e.g., feature/new-example).
3. Run npm run generate:new-example to automatically create the required files and folder structure.
4. Develop and test your example to ensure it functions as intended.
5. Submit a pull request for review once all changes are finalized.

Additional Notes

• Ensure your example works fully and is well-documented for ease of use.
• Stick to the coding standards to keep the repository consistent.
• For questions or support, open an issue or reach out to the maintainers.

Feedback

Have ideas to improve this hub or run into any issues? We’d love to hear from you! Please share your thoughts via GitHub Issues. Your feedback helps us enhance this resource for all developers.