/feeling-lucky

The button, when clicked, will fetch a random joke from the JokeAPI and display it to the user, providing a fun and innovative experience on Warpcast. You can paste this code into your local Vercel dev environment to deploy the frame.

Primary LanguageJavaScript

Feeling Lucky - Warpcast Frame Deployment Guide

Overview

"Feeling Lucky" is a Warpcast frame that delivers a dose of humor with a simple click. Designed for those who appreciate a good laugh, it fetches a random joke, blending traditional dad jokes with a touch of adult humor, while steering clear of sensitive topics. This project is a testament to the collaborative power of AI and creativity, tailored for artists and creators diving into the world of coding.

Features

  • Random Joke Generation: Delivers a mix of one-part and two-part jokes.
  • Responsive Design: Ensures a seamless experience across all devices.
  • User-Friendly Interface: Easy navigation with a single "I'm Feeling Lucky" button.

Prerequisites

  • Node.js and npm installed
  • Basic familiarity with GitHub and Vercel
  • Vercel account for deployment

Setup and Deployment

Local Setup

  1. Clone the project repository to your local machine.
  2. Navigate to the project directory and install dependencies with npm install.
  3. Start the local development server with npm start or node im-feeling-lucky-frame.js.

Pushing to GitHub

  1. Initialize a new GitHub repository and note the repository URL.
  2. Connect your local repository to GitHub with git remote add origin [repository URL].
  3. Push your code to GitHub with git push -u origin master.

Deploying to Vercel

  1. Install the Vercel CLI globally with npm install -g vercel.
  2. In your project directory, run vercel to initiate deployment.
  3. Follow the prompts to link your project to Vercel and deploy.

Testing with Vercel Dev

  • Run vercel dev in your project directory to start a local development server emulating the Vercel environment, allowing you to test your frame before the final deployment.

Integrating with Warpcast

  1. Once deployed, grab the Vercel deployment URL.
  2. Visit Warpcast's frame validator and enter your deployment URL to ensure compatibility.
  3. Follow Warpcast's guidelines to finalize the integration of your frame.

Additional Resources

License

This project is licensed under the terms of the MIT license, courtesy of Jams2blues Creations LLC. See the LICENSE.txt file for license rights and limitations.

Acknowledgments

  • Sv443 and the Sv443 Network for JokeAPI
  • OpenAI and Evo.ninja for AI collaboration
  • The Warpcast and Farcaster communities

Contributing

Contributions are welcome! Please feel free to fork the repository, make your changes, and submit a pull request.

Contact

For more information, reach out to Jams2blues Creations LLC at jams2blues@savetheworldwithart.io

This README serves as a guide and memory aid for both humans and AI, encapsulating the collaborative journey of creating a basic frame on Warpcast. Happy framing!