README.md

AI Oracle Frame Template

This is a template for building AI powered frame using ORA's AI Oracle.

DISCLAIMER

The purpose of this templte is to help people get started with AI dapps development. The codebase is NOT audited. Use it at your own risk.

Template Structure

api - defines api endpoints, which execute actions and return frame metatags

lib - helper functions

public - directory containing frame images

Getting Started

1. copy .env.example into .env and add values to environment variables
2. modify frame logic as you wish, by changing files within api folder
3. run the frame locally: yarn dev

Test Your Frame

1. Run the development server: yarn dev
2. Use ngrok to expose your local frame
3. Test the frame with https://warpcast.com/~/developers/frames

If you don't want to use ngrok, you can test the frame using local debugger from frames.js.

Deploy to Production

1. run vercel --prod to deploy your frame to vercel
2. cast a frame on Farcaster client (eg. Warpcast), using link to the production deployment

Deploying contracts

In order to develop and deploy contracts for your AI Oracle Frame application, you can use this template repository.

AI Oracle Frame Examples

• FortuneTeller

Learn More

• Onchain AI Oracle tutorial - understand how to utilise verifiable AI in your dapps.
• Farcaster docs - Farcaster docs
• Base Onchain Kit - Base framework for building frames