DEVELOPER REFERENCE — LIBRARY LOOT
Library Loot
Developer Reference
 ← Index

Home

Library Loot — Developer Reference

Luckey Logic LLC · Public Repo

Auto-generated API reference for the Library Loot multi-tenant reading-rewards platform. Browse components, pages, context providers, models, and utilities using the Contents panel on the right. Type into the filter to narrow the list. Use the in-file text search on a source page to jump between matches.

This site auto-builds on every push to main and deploys to library-loot.web.app/docs/ alongside the app (ITEM 2h). To preview locally, run npm run docs — the output (docs/) is gitignored.

Quick Links

Area Lives in What's in it
Public pages src/pages/ Home, About, Donors, Sponsor, Books, BookDetail, FAQ, ForParents, Account, Login, Signup, AdminSetup, Terms, Privacy, NotFound
Admin pages src/pages/admin/ AdminIndex (overview), AdminSettings, AdminBooks (CRUD + ISBN scanner + cover upload), AdminAvatars (avatar pack manager + lightbox)
Components src/components/ Navbar, Footer, Disclaimer, PrivateRoute, AdminRoute, AdminLayout, AvatarPicker, ChildCard, ChildForm, HonestyPledge, IsbnScanner
Hooks src/hooks/ useTenantSettings (live _main settings reader), useLockBodyScroll (modal/overlay scroll lock)
Context src/context/ AuthContext / useAuth — auth state, sign-in helpers, custom-claim reads
Firebase src/firebase.js, src/firebase/tenant.js Firebase client init and the single-source-of-truth tenant root helper
Site content src/data/siteContent.js Brand info, fallback support contact, base legal copy (live tenant overrides come from _main.support / _main.legal)

Where things live

  • Firestore data model — see SPEC.md at the repo root (canonical schema, prize-selection algorithm, COPPA stance, legal disclaimers, handoff procedure).
  • Build list + decisions — see CLAUDE.md at the repo root (item-by-item status, session notes, style guide).
  • Cloud Functions — under functions/src/. Each callable lives in its own module. Not currently documented here; JSDoc points at src/ only.
  • Operator scripts — under scripts/. Use a service-account JSON to provision tenants, backfill claims, and inspect users.

Conventions

  • 2-space indentation across all source.
  • CSS variables only — never hardcode colors. Tokens live in src/styles/tokens.css and are shared between the React app and this docs site.
  • JSDoc on every component, exported function, model class, and utility.
  • Multi-tenant: every Firestore / Storage path routes through src/firebase/tenant.js. No hardcoded tenant IDs anywhere in app code.

Fortnite / V-Bucks usage

Library Loot uses Fortnite-styled art and lists V-Bucks gift cards as one of the prize categories under Epic Games' Fan Content Policy. The platform is non-commercial — neither Luckey Logic, the libraries, nor any participant earns money from it. Library Loot is not affiliated with, endorsed, or sponsored by Epic Games.

If you are contributing to this codebase or operating a tenant: stay inside the Fan Content Policy. No Epic Games logos, no Fortnite logos, no mocking of official Fortnite marketing layouts. Hero art and any Fortnite-styled visuals live in Firebase Storage with URLs in siteContent.js so swapping them out is one upload + one string change if Epic ever pushes back.