Skip to content

README.md

Latest commit

 

History

History
110 lines (87 loc) · 3.45 KB

README.md

File metadata and controls

110 lines (87 loc) · 3.45 KB

Vaibe Arcade

Vaibe Arcade is a modern, AI-powered gaming platform and creator ecosystem. It features a rich catalog of games, real-time leaderboards, quest systems, and a dedicated zone for creators to manage their content and view analytics.

🚀 Tech Stack

Frontend

  • Framework: React 18 with Vite
  • Language: TypeScript
  • Styling: Tailwind CSS + Radix UI
  • State Management: TanStack Query (React Query)
  • Icons: Lucide React & Heroicons

Backend

  • Framework: FastAPI (Python)
  • Database & Auth: Supabase (PostgreSQL)
  • AI Integration: Google Generative AI (Gemini) & Replicate
  • Middleware: CORS & GZip compression

Infrastructure

  • Hosting: Vercel (Frontend & Backend)
  • Database: Supabase with migrations and real-time triggers

✨ Key Features

  • 🎮 Game Hub: Integrated Unity game embeds with session tracking and ratings.
  • 🏆 Leaderboards: Dynamic weekly and all-time leaderboards with historical tracking.
  • 🗺️ Quests & Raffles: Gamified user engagement through questing and raffle systems.
  • 🎨 Creator Zone: A specialized dashboard for creators to manage games and view player insights.
  • 💰 Shop & Economy: Virtual currency system (Atomic Coins) with an integrated shop.
  • 🤖 AI-Powered: Generative AI capabilities for asset creation and assistant features.

🛠️ Project Structure

├── backend/            # FastAPI Python server
│   ├── app/            # Main application logic
│   │   ├── api/        # API endpoints (v1)
│   │   ├── core/       # Config and security
│   │   ├── crud/       # CRUD operations
│   │   ├── db/         # Database (Supabase)
│   │   ├── models/     # Database models
│   │   └── schemas/    # Pydantic schemas
│   └── main.py         # Local development entry point
├── frontend/           # React + Vite application
│   ├── src/            # Source code
│   │   ├── components/ # Reusable UI components
│   │   ├── contexts/   # React contexts (Auth, Game)
│   │   ├── hooks/      # Custom React hooks
│   │   └── pages/      # Application views/routes
├── supabase/           # Migrations, seed data, and Edge Functions
└── scripts/            # Utility development scripts

🏁 Getting Started

Prerequisites

  • Node.js (v18+)
  • Python (v3.11+)
  • Supabase Account

Installation

  1. Clone the repository:

    git clone <repo-url>
cd arcade

  2. Install all dependencies:

    # From the root directory
npm run install:all

  3. Environment Setup: Create a .env file in the backend/ directory with the following:

    SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_key
GOOGLE_API_KEY=your_google_ai_key
REPLICATE_API_TOKEN=your_replicate_token

Running Locally

  • Run Everything: Use the root commands to start both services.

    # Frontend
npm run dev

# Backend
npm run dev:backend

  • Manual Start:

    # Frontend
cd frontend && npm run dev

# Backend
cd backend && source .venv/bin/activate && uvicorn app.main:app --reload

📦 Deployment

The project is configured for seamless deployment on Vercel.

  • Frontend is deployed as a static site.

  • Backend is deployed as Serverless Functions via the vercel.json configuration in the root.