Skip to content

worldcoin/minikit-web3-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mini Apps Web 3 Template

The intention for this project is to enable Mini App Builders to easily create new Next.js mini apps.

The example implemented here is a simple mini app that makes you connect and claim a simple ERC20 token every 5 minutes.

Basic Commands used

  1. Connect Wallet or Wallet Auth using Next Auth for Sessions
  2. Verify With World ID Command requesting Orb verification level to proceed.
  3. Send Transaction for minting and send the user a $TUTE ERC 20 token just for being verified. This refreshes every 5 minutes.

Dependencies


🛠️ Setup

1. Clone the repository

git clone https://github.com/mateosauton/MiniAppWeb3template.git
cd MiniAppWeb3template

2. Install dependencies

pnpm install

3. Configure your environment variables

Copy the example environment file:

cp .env.example .env

Then fill in the required variables:

🔑 APP_ID

Find your App ID in the Developer Portal (Configuration > Basic).

Incognito Action

Define an action in the developer portal under the Incognito Actions tab, copy it, and include it in the .env file


▶️ Running the Project

Run your Mini App locally:

pnpm dev

Visit http://localhost:3000 in your browser.


📱 Testing on Mobile

To test your Mini App directly on your phone, expose your app publicly using NGROK.

🚀 Using NGROK

Install NGROK and run:

ngrok http http://localhost:3000

NGROK provides a publicly accessible URL.

🌎 Configuring Your App (Developer Portal)

Go to the Developer Portal and configure:

  • App URL: Set it to your NGROK-generated URL.
image

📱 Opening your Mini App in World App

From the Developer Portal, navigate to Configuration > Basic and scan the generated QR code.


📞 Contact

Questions or feedback? Feel free to reach out!


🔗 Useful Links


About

minikit-web3-example repository

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •