Skip to content

0xsksingh/bnbdevsdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 

Repository files navigation

BNB Dev SDK

Build BNB Full-stack, type-safe web3 applications on any BNB-supported chain like BNB, OpBNB, and BNB-Greenfield.

Get started with BNB Dev SDK by running npx bnb-dev-sdk create my-bnb-app

What is BNB Dev SDK?

BNB Dev SDK is a comprehensive web3 development stack created by Kamal Singh and powered by hardhat. It is designed to help developers create full-stack web3 applications on BNB-compatible chains with ease.

Key Features:

  • TypeScript: Ensures type-safe development throughout your project.
  • Modular Structure: Divided into two main parts:
    1. Contracts: Utilizes Solidity, the Hardhat framework, and hardhat. Ready for deployment on all BNB-supported chains including BNB, OpBNB, and BNB-Greenfield.
    2. Application: Built with Next.js, Tailwind CSS, shadcn/ui, and hardhat.

This opinionated template focuses on developer experience, aiming to create performant, scalable, and secure web3 applications with elegant user interfaces.

Why Use BNB Dev SDK?

BNB Dev SDK includes everything you need in a modern web3 development stack:

  • Type-Safe Environment: Leverage TypeScript for consistency and reliability across your project.
  • Beautiful UI Components: Utilize shadcn/ui for pre-built components and customize your styles with Tailwind CSS.
  • Smooth Onboarding: Provide seamless onboarding experiences with support for local wallets and account abstraction.
  • Decentralized Services Integration: Easily connect to decentralized services using the provided infrastructure.

Getting Started

To start building your web3 application with BNB Dev SDK, run the following command:

npx bnb-dev-sdk create my-bnb-app

This command sets up a new project with the necessary structure and dependencies to get you up and running quickly.

Example Structure

my-bnb-app/
├── contracts/
│   ├── hardhat.config.ts
│   ├── contracts/
│   └── scripts/
├── application/
│   ├── pages/
│   ├── styles/
│   ├── components/
│   └── public/
└── package.json
  • /contracts: Contains your Solidity contracts, Hardhat configuration, and deployment scripts, ready for deployment on BNB, OpBNB, and BNB-Greenfield.
  • /application: Includes your Next.js application with styling and UI components.

Contributing

Contributions are welcome! If you have suggestions or find any issues, please open an issue or submit a pull request on GitHub.

License

BNB Dev SDK is licensed under the MIT License. See the LICENSE file for more details.


Build your next web3 project with confidence using BNB Dev SDK, and join the growing community of developers leveraging the power of BNB-compatible chains.