Installation

Getting started with dAppBooster in just a few minutes

dAppBooster's installation script

Run the script

Get a clean instance of the starter-kit by running this command.

You can select between several configuration options for your installation, remove optional packages, etc. Choose what you need for your particular project.

Terminal

pnpm dlx dappbooster

Change the remote (optional)

After you're finished with the installation, you might want to change your project's remote repository to a different one.

Terminal

git remote set-url origin <your-repository-url>

Running the dApp

To run the dApp in dev mode use this command and open the link provided in your browser.

Terminal

pnpm dev

You can start modifying the content of the home page by editing src/components/pageComponents/home/index.tsx, the page auto-updates as you edit the file.

A note regarding subgraphs

There are no additional configuration requirements for the most part but if you opted-in for subgraph support, you'll need to provide the required environment vars in .env.local for the subgraph features to work.

.env.local

# Subgraph API key
PUBLIC_SUBGRAPHS_API_KEY='Your API key'
# Environment
PUBLIC_SUBGRAPHS_ENVIRONMENT='production'
# comma separated list of <chainId>:<subgraphId>:<resourceId>
PUBLIC_SUBGRAPHS_CHAINS_RESOURCE_IDS=''
 
# URLs for the subgraphs in development and production
# must have the replaceable strings [apiKey], [resourceId], and optionally [subgraphId]
PUBLIC_SUBGRAPHS_DEVELOPMENT_URL=''
PUBLIC_SUBGRAPHS_PRODUCTION_URL=''

Terminal

pnpm subgraph-codegen

Warming engines

And that's it!

We recommend starting with the My first dApp recipe to see how easy it is to build a dApp with our starter kit. In just five minutes, this guide will show you how to create a dApp that lets you wrap and unwrap WETH on the Sepolia network. This hands-on introduction is an excellent first step to using dappBooster and getting familiar with its components.