Skip to content

logiccrafterdz/BaseFeeds

Repository files navigation

BaseFeeds – Your Onchain Social Pulse 🔵

A modern Progressive Web App (PWA) that brings together the best of Base blockchain and Farcaster social content in one beautiful, neon-themed interface.

BaseFeeds Preview BaseFeeds Preview

✨ Features

  • 🔵 Base NFT Discovery: Explore trending NFTs on the Base blockchain with real-time data
  • 📱 Farcaster Integration: Stay updated with the latest casts from your favorite creators
  • ⚡ Progressive Web App: Install on any device for a native app experience
  • 🎨 Neon UI Theme: Beautiful, modern interface with smooth animations
  • 📊 Analytics Dashboard: Track trending content and engagement metrics
  • 🔍 Smart Caching: Offline-first approach with intelligent data caching
  • 🌐 Cross-Platform: Works seamlessly on desktop, tablet, and mobile
  • 🚀 Performance Optimized: Built with Next.js 14 and optimized for speed

🚀 Quick Start

Prerequisites

  • Node.js 18.0.0 or higher
  • npm or yarn package manager

Installation

  1. Clone the repository

    git clone https://github.com/your-username/basefeed.git
    cd basefeed
  2. Install dependencies

    npm install
  3. Set up environment variables

    cp .env.local.example .env.local
  4. Configure your API keys (see API Keys Setup)

  5. Start the development server

    npm run dev
  6. Open your browser Navigate to http://localhost:3000

🔑 API Keys Setup

Neynar API (Farcaster)

  1. Visit Neynar.com and create an account
  2. Generate an API key from your dashboard
  3. Add to your .env.local:
    NEXT_PUBLIC_NEYNAR_API_KEY=your_neynar_api_key_here

Optional Configuration

# Enable/disable mock data for development
NEXT_PUBLIC_USE_MOCKS=false

# WalletConnect Project ID (for wallet connections)
NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID=your_project_id_here

# Analytics (optional)
NEXT_PUBLIC_ANALYTICS_ID=your_analytics_id_here

🛠️ Development

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run start - Start production server
  • npm run lint - Run ESLint
  • npm run lint:fix - Fix ESLint issues
  • npm run type-check - Run TypeScript type checking
  • npm run format - Format code with Prettier
  • npm run format:check - Check code formatting

Project Structure

src/
├── app/                 # Next.js 14 App Router
│   ├── api/            # API routes
│   ├── analytics/      # Analytics page
│   ├── explore/        # Explore page
│   └── trending/       # Trending page
├── components/         # React components
├── hooks/              # Custom React hooks
├── lib/                # Utility libraries
└── store/              # Zustand state management

🏗️ Tech Stack

  • Framework: Next.js 14 with App Router
  • Styling: Tailwind CSS with custom neon theme
  • State Management: Zustand
  • Data Fetching: TanStack Query (React Query)
  • Animations: Framer Motion
  • Web3: Wagmi + Viem
  • PWA: next-pwa
  • TypeScript: Full type safety
  • Caching: IndexedDB with localStorage fallback

📱 PWA Features

BaseFeeds is a fully-featured Progressive Web App:

  • Installable: Add to home screen on any device
  • Offline Support: Works without internet connection
  • Background Sync: Updates content when connection returns
  • Push Notifications: Stay updated with latest content (coming soon)
  • App-like Experience: Native feel on mobile and desktop

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Base - The L2 blockchain powering our NFT data
  • Farcaster - The decentralized social protocol
  • Neynar - Farcaster API infrastructure
  • Zora - NFT marketplace and protocol

📞 Support


Built with ❤️ for the Base and Farcaster and Zora communities

About

A modern Progressive Web App (PWA) that brings together the best of Base blockchain and Farcaster social content in one beautiful interface.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors