Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/base-app/build-with-minikit/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ MiniKit is easiest way to build Mini Apps on Base, allowing developers to easily

## Why MiniKit?

MiniKit streamlines mini-app development by providing a comprehensive toolkit that makes complex Frames SDK interactions intuitive:
MiniKit streamlines mini-app development by providing a comprehensive toolkit that makes complex Farcaster SDK interactions intuitive:

<CardGroup cols={2}>
<Card title="Simplified Development" icon="code">
Build apps with minimal knowledge of the Frames SDK
Build apps with minimal knowledge of the Farcaster SDK
</Card>

<Card title="Coinbase Wallet Integration" icon="wallet">
Expand Down Expand Up @@ -78,7 +78,7 @@ Create a demo app showcasing onchain abilities using OnchainKit
After running the command, follow the prompts to configure your project.

<Info>
We recommend using [Vercel](https://vercel.com) to deploy your MiniKit app, as it integrates seamlessly with the upstash/redis backend required for frames, webhooks, and notifications. The CLI will guide you through setting up the necessary environment variables for your Redis database.
We recommend using [Vercel](https://vercel.com) to deploy your MiniKit app, as it integrates seamlessly with the upstash/redis backend required for webhooks, and notifications. The CLI will guide you through setting up the necessary environment variables for your Redis database.
</Info>

## Provider
Expand Down Expand Up @@ -116,7 +116,7 @@ Optional URL to override the default `/api/notification` proxy
All props from `OnchainKitProvider` are also supported
</ParamField>

The provider sets up wagmi and react-query providers automatically. It configures connectors to use the Farcaster connector if `sdk.context` is set, with a fallback to CoinbaseWallet. This allows the same application to run both in frames and as a standalone application.
The provider sets up wagmi and react-query providers automatically. It configures connectors to use the Farcaster connector if `sdk.context` is set, with a fallback to CoinbaseWallet. This allows the same application to run both as a Mini App and as a standalone application.

## Hooks

Expand Down Expand Up @@ -161,7 +161,7 @@ The notification proxy URL

### useAddFrame

This hook adds a frame to the user's list of frames and returns notification details.
This hook adds a Mini App to the user's list of Mini Apps and returns notification details.

```tsx
const addFrame = useAddFrame();
Expand Down Expand Up @@ -374,10 +374,10 @@ The CLI creates an application with:

<AccordionGroup>
<Accordion title="Frontend and Backend Integration">
Complete setup for adding frames, webhooks, and notifications using upstash/redis for data storage (compatible with Vercel). Requires users to sign up for an upstash/redis account and add their key and URL to the .env file.
Complete setup for adding Mini Apps, webhooks, and notifications using upstash/redis for data storage (compatible with Vercel). Requires users to sign up for an upstash/redis account and add their key and URL to the .env file.

<Info>
The CLI creates both frontend and backend components to support adding frames, webhooks, and notifications. While a frontend-only option was considered, the ability to add frames and handle notifications requires backend support. If you don't need these features, you can easily remove the database and related routes after project creation.
The CLI creates both frontend and backend components to support adding Mini Apps, webhooks, and notifications. While a frontend-only option was considered, the ability to add Mini Apps and handle notifications requires backend support. If you don't need these features, you can easily remove the database and related routes after project creation.
</Info>
</Accordion>

Expand Down
6 changes: 3 additions & 3 deletions docs/base-app/build-with-minikit/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Before you begin developing with MiniKit, you'll need:

## What is a Mini App?

A mini app is a lightweight web app that runs directly inside [Farcaster Frames](https://docs.farcaster.xyz/developers/frames/v2/), without needing to open a browser or download anything. Built using familiar tools like Next.js and minikit, mini apps behave just like normal apps — but launch instantly from posts, making them feel native to the Farcaster experience.
A mini app is a lightweight web app that runs directly inside [Farcaster](https://docs.farcaster.xyz/developers/frames/v2/), without needing to open a browser or download anything. Built using familiar tools like Next.js and minikit, mini apps behave just like normal apps — but launch instantly from posts, making them feel native to the Farcaster experience.

## Initial Setup

Expand All @@ -30,7 +30,7 @@ npx create-onchain --mini
You can get a CDP API key by going to the [CDP Portal](https://www.coinbase.com/developer-platform) and navigating API Keys → Client API Key.
</Step>

<Step title="Skip Frames Account Manifest Setup">
<Step title="Skip Mini App Account Manifest Setup">
You will be asked if you'd like to set up your manifest. You can skip the manifest setup step as we'll handle that separately once we know our project's URL.
</Step>

Expand All @@ -51,7 +51,7 @@ These docs are LLM-friendly—reference [llms.txt](https://docs.base.org/base-ap

To test your Mini App in Farcaster, you'll need a live URL.

We recommend using [Vercel](https://vercel.com) to deploy your MiniKit app, as it integrates seamlessly with the upstash/redis backend required for stateful frames, webhooks, and notifications.
We recommend using [Vercel](https://vercel.com) to deploy your MiniKit app, as it integrates seamlessly with the upstash/redis backend required for stateful Mini Apps, webhooks, and notifications.

Alternatively, you can use ngrok to tunnel your localhost to a live url.

Expand Down