Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
88 lines (60 loc) · 2.16 KB

GETTING_STARTED.md

File metadata and controls

88 lines (60 loc) · 2.16 KB

🖼️ Coordinape Frames

This repository contains Farcaster Frames for Coordinape, built using the Frames v2 SDK.

🚀 Getting Started

Prerequisites

  • Node.js (v18 or higher recommended)
  • pnpm package manager
  • ngrok for local development testing

Installation

  1. Clone the repository:
git clone [your-repo-url]
cd [repo-name]
  1. Install dependencies:
pnpm install
  1. Start the development server:
pnpm dev
  1. In a separate terminal, start ngrok to expose your local server:
ngrok http 3000

🎮 Testing Your Frames

  1. Open the Frame Playground on Warpcast (Mobile only)
  2. Enter your ngrok URL
  3. Tap "Launch" to test your frame

📦 Project Structure

.
├── app/                    # Next.js app directory
│   ├── components/        # React components
│   ├── providers/        # App providers (Wagmi, etc.)
│   └── page.tsx         # Main app page
├── lib/                  # Utility functions and shared code
└── public/              # Static assets

🛠️ Development Guidelines

  1. Frame Components: Create new frame components in app/components/frames/
  2. Testing: Test your frames thoroughly in the Warpcast playground before deploying
  3. State Management: Use React hooks for local state, context for global state
  4. Styling: Use Tailwind CSS for styling components

🔑 Environment Variables

Create a .env.local file in the root directory with the following variables:

# Add any required environment variables here

📚 Useful Resources

🤝 Contributing

  1. Create a new branch for your feature
  2. Make your changes
  3. Test thoroughly in the Frame Playground
  4. Submit a pull request

📝 License

[Add your license information here]