Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 4.25 KB

INDEX.md

File metadata and controls

68 lines (51 loc) · 4.25 KB

BOLIYAN PROJECT INDEX

Central Navigation Hub

📖 READ THE MANIFESTO

🚀 MISSION & VALUES

Boliyan is built to become the Default Operating System for Pakistan's secondary economy. We stand for:

  1. Respect for Time: No window shoppers. No "Is this available?".
  2. High Intent: Bidding is the only way to start a conversation.
  3. Ruthless Minimalism: If a visual cue works, we delete the text.

🗺️ NAVIGATOR

📜 Root Documentation

  • Project Rules (AGENTS.md) — Operational Rules & Design Philosophy.
  • Manifesto — Product Vision & Mission.
  • Gemini Knowledge — Detailed Project Knowledge Base.

📂 Apps (Frontend)

Core Logic & Hooks

  • Web App Logic (apps/web/src/lib) — Store, Supabase client, Utilities.
  • Hooks (apps/web/src/hooks) — Custom React Hooks (Bidding, Realtime, Sound, etc.).

Component Directories (apps/web/src/components/)

  • Common — Shared badges, controls, and domain primitives (22 components).
  • Marketplace — Core interactions (ItemCard, Grid, Filters, ProductDetails).
  • Dashboard — My Bids, My Listings, Watchlist, Settings.
  • Inbox — Chat window, conversation list, message UI.
  • Notifications — Notification feed, dropdown, and items.
  • Auth — Authentication dialog and Turnstile captcha.
  • Search — Search bar, category nav, similar items.
  • Seller — Seller listing card and confirmation dialogs.
  • Profile — Reviews, ratings, profile completeness.
  • Layout — Navbar, Footer, BottomNav, Sidebar, ScrollToTop.
  • Branding — Logo and loader mark.
  • Analytics — Google Analytics integration.
  • Ads — Ad card and banner ad.
  • Admin — Admin guard component.
  • UI Primitives — Shadcn + Radix primitives.

📦 Packages (Backend & Shared)

  • Database (packages/database) — Raw SQL Schema & Migrations.
  • Shared Logic (packages/shared) — Validation & Business Logic.

🏗️ ARCHITECTURE OVERVIEW

Monorepo Structure

Boliyan uses a manual monorepo structure (no Turborepo/Nx yet) to keep things simple.

  • apps/web: The main Next.js 16 application.

    • Uses a custom Context Provider architecture (MarketplaceContext, AuthContext, etc.) for state management.
    • Live Data: Powered by Supabase. Real-time subscriptions for bids and messaging.

  • packages/database: The Source of Truth for data.

    • Native SQL: Raw SQL schema files (schema.sql). No ORM.

  • packages/shared: Isomorphic business logic.

    • Code here must run in both Browser and Node.js environments.
    • Used for validating bids, parsing amounts, etc.

🔍 QUICK LINKS

  • Global Store (Compatibility Layer)
  • Database Schema