Skip to content

README.md

Latest commit

 

History

History
110 lines (82 loc) · 2.81 KB

README.md

File metadata and controls

110 lines (82 loc) · 2.81 KB

🎮 BITWAVE - Retro Gaming Platform

Play. Earn. Repeat. 💰

BITWAVE is a retro gaming platform where you can play classic mini-games, earn rewards, and collect tokens. Experience the nostalgia of pixel-perfect gaming with modern blockchain rewards!

✨ Features

🕹️ Retro Mini-Games - Play classic games like Mario vs Donkey Kong, DOOM, Duck Hunt, and Tetris
💎 Starknet Integration - Earn and manage tokens on the Starknet blockchain
🎁 VESU Rewards - Collect rewards while playing your favorite games
🌙 Dark Theme - Beautiful dark UI with orange/gold accents
📱 Mobile-First - Optimized for mobile gaming experience
🔐 Social Auth - Login with Google or Apple

🎯 How It Works

  1. 🪙 Insert a coin - Buy tokens to play retro mini-games
  2. 😊 Enjoy - Play your favorite retro games
  3. 💸 Get reward - Earn rewards while playing

While you play, your tokens generate yield. When you're out of tokens, buy more and keep earning!

🛠️ Tech Stack

  • ⚡ Vite - Lightning fast build tool
  • 🔷 TypeScript - Type-safe development
  • ⚛️ React - Modern UI framework
  • 🎨 Tailwind CSS - Utility-first styling
  • 🧩 shadcn/ui - Beautiful component library
  • 🌐 React Router - Client-side routing
  • 📱 Mobile-Responsive - Perfect on all devices

🚀 Getting Started

Prerequisites

  • Node.js 18+
  • npm or pnpm

Installation

# Clone the repository
git clone <YOUR_GIT_URL>
cd bitwave

# Install dependencies
npm install

# Start development server
npm run dev

Available Scripts

npm run dev        # 🔥 Start development server
npm run build      # 📦 Build for production
npm run preview    # 👀 Preview production build
npm run lint       # 🔍 Lint code

📱 Pages & Features

🏠 Home

  • Grid of retro game cards
  • Quick access to "How it works"

🛒 Store

  • Buy token packages with Starknet
  • Multiple coin pack options
  • Real-time balance display

👤 Profile

  • Wallet information display
  • VESU rewards claiming
  • Deposit/Withdraw functions
  • Logout functionality

🔐 Authentication

  • Clean, minimalist login page
  • Google & Apple OAuth integration
  • Mobile-optimized design

❓ How It Works

  • Simple 3-step explanation
  • Visual icons for each step
  • Additional game information

🤝 Development

Project Structure

src/
├── components/     # Reusable UI components
├── pages/         # Application pages
├── assets/        # Images and static files
├── hooks/         # Custom React hooks
└── lib/           # Utility functions

Contributing

  1. 🍴 Fork the repository
  2. 🌿 Create a feature branch
  3. 💫 Make your changes
  4. 🚀 Submit a pull request

🎮 Start playing and earning today! 💰