Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basenames frames tutorial #1005

Merged
merged 12 commits into from
Sep 20, 2024
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions apps/base-docs/docs/tools/basenames-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,13 @@ Basenames are built using the Ethereum Name Service (ENS) protocol, leveraging i
### 17. Do Basenames work on different chains?

Yes, your Name will work on any chain as long as the app is ENSIP-10 compliant. Note that when sending money or interacting across different chains, you should ensure the receiving platform supports ENS.

### 18. How do I use frames with my basename?

You can pin frames as the ultimate way to make a profile yours. Want someone to mint? Frame it. Want someone to pay you? Frame it. Want to display your onchain identity your own way? Frame it.

Follow our step-by-step [guide] to get started. While Basenames supports all frames, we recommend using the Open Frames standard for the best experience.

---

[guide]: https://docs.base.org/tutorials/add-frames-to-basename
111 changes: 111 additions & 0 deletions apps/base-docs/tutorials/docs/5_basename-frames.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
title: 'Add Frames to A Basename'
slug: /add-frames-to-basename
description: Learn how to customize your Basename by adding Frames, showcasing dynamic content with ease on Base.
author: hughescoin
keywords:
[
Sponsored Transactions,
Onchain,
Coinbase,
Base,
Crypto,
Cloud Platform,
Basenames,
Frames,
Profile Customization,
Open Graph,
ENS,
]
tags: ['account abstraction', 'Paymaster']
difficulty: easy
hide_table_of_contents: false
displayed_sidebar: null
---

# Add Frames to A Basename

Welcome to the exciting world of Frames for your Basename! This tutorial will guide you step-by-step through adding a frame to your Basename, allowing you to personalize and display unique content on the Base blockchain.

## What Are Frames?

Frames are dynamic visual elements that display custom content on your Basename using any [Open Graph spec] extensions. You may be familiar with frames from platforms like [Warpcast], where they are used to enhance social interactions like minting NFTs onchain, sharing information, and more. Open Frames work similarly, but they are independent of Warpcast are the best way for adding frames to your Basename. With Open Frames, anyone can create and display content directly on their Basename.

## Prerequisites

Before you begin, ensure you have the following:

- A registered Basename. [Claim a basename](https://www.base.org/names)
- A small amount of ETH to submit the text record onchain

## Navigate to Your Basename

To get started, head over to a Basename that you own. For example:

`https://www.base.org/name/pathughes`

![basenames-profile-homepage](../../assets/images/basenames-tutorial/basenames-homepage.png)

## Look for the Frame Banner

Once you're on your profile, you’ll be greeted with a new banner inviting you to pin a frame to your profile. Look for the call-to-action button and click `Try it now`.

![try-now-buton](../../assets/images/basenames-tutorial/try-now.png)

## Explore the Frame Selection Panels

You’ll now see two panels to help you choose and preview frames for your profile:

- **Left Panel**: This panel contains pre-built frames created by the Base community.
- **Right Panel**: Here, you can preview how the selected frame will look on your Basenames profile.

![frame-selector-page](../../assets/images/basenames-tutorial/frames-selector.png)

## Choose a Frame

You can select any frame from the available options. For this tutorial, we’ll use the pre-built "Pay Me" Frame by [Paycaster](https://paycaster.co/), which allows anyone to gift you USDC or ETH.

Click on the dropdown menu to select the "Pay Me" Frame.

![frame-payme-](../../assets/images/basenames-tutorial/show-preview.png)

## Preview the Frame

Once you've selected the frame, click on the `Show preview` button to see how it will appear on your profile.

![Frame-preview](../../assets/images/basenames-tutorial/frame-preview.png)

## Add the Frame to Your Profile

If you're happy with the preview, it's time to add the frame to your profile! Click the `Add frame` button.

You'll be prompted to confirm the transaction in your wallet. Approve the transaction, and the page will automatically reload.

![confirm-txn](../../assets/images/basenames-tutorial/confirm-txn.png)

## View Your Updated Profile

After the page reloads, you’ll see your profile with the newly added frame. Congratulations! You’ve successfully added a frame to your Basenames profile.

![profile](../../assets/images/basenames-tutorial/basenames-frame-final.png)

Feel free to customize your Frames further or explore new designs from the community!

## Resources

For more information on Frames and how to customize them, check out the following resources:

- [Open Frames Spec](https://www.openframes.xyz/#required-properties)
- [Frames Debugger](https://debugger.framesjs.org/)
- [Openframes Website](https://www.openframes.xyz/)
- [Open Graph spec](https://ogp.me/)
- [Warpcast](https://warpcast.com/)

---

[Open Frames Spec]: https://www.openframes.xyz/#required-properties
[Open Frames]: https://www.openframes.xyz/
[Frames Debugger]: https://debugger.framesjs.org/
[Openframes Website]: https://www.openframes.xyz/
[Open Graph spec]: https://ogp.me/
[Warpcast]: https://warpcast.com/
Loading