Lantern Documentation Index

Welcome to the Lantern docs. This index links to the most useful references for developers and stakeholders.

🚀 Getting Started (San Diego Pilot)

• Quick start: business/QUICK_START_PILOT.md ⭐ START HERE
  • Overview of pilot timeline, risks/rewards, unit economics, decision checkpoints
• Founder context: business/FOUNDER_CONTEXT.md — your story, market positioning, merchant narratives
• Pilot strategy: business/PILOT_STRATEGY.md — detailed financial model, phases, metrics

Quick Links

• Getting started & scaffold: docs/engineering/SCAFFOLD.md
• Environment setup: docs/engineering/ENVIRONMENT_SETUP.md ⭐ START HERE FOR DEPLOYMENT
• Deployment guide: docs/engineering/DEPLOYMENT.md — Full Cloudflare + Firebase setup
• Storybook deployment: docs/engineering/deployment/STORYBOOK_DEPLOYMENT.md — Deploy component library to website
• Docs deployment: docs/engineering/deployment/DOCS_DEPLOYMENT.md — Deploy documentation to subdomain
• PWA setup & testing: docs/engineering/PWA.md
• Tech stack overview: docs/engineering/TECHSTACK.md
• API design notes: docs/engineering/API.md
• Light Lantern Flows: ⭐ UPDATED
  • Flow documentation: docs/features/LIGHT_LANTERN_FLOWS.md — Both flows, shared hook, architecture
  • Refactor summary: docs/features/LIGHT_LANTERN_REFACTOR_PROPOSAL.md — Implementation complete
• Privacy & Profile System: ⭐ NEW
  • Privacy-first profiles: docs/features/profile/PRIVACY_FIRST_PROFILE.md — No photos, no age display, encrypted data
  • Zero-knowledge encryption: docs/engineering/ZERO_KNOWLEDGE_ENCRYPTION.md ⭐ CRITICAL — We literally cannot decrypt user data
  • Visual guide to encryption: docs/engineering/ZERO_KNOWLEDGE_VISUAL_GUIDE.md — Diagrams & flowcharts
  • Security architecture: docs/engineering/SECURITY_ARCHITECTURE.md ⭐ NEW — Complete security approach & community program
  • User security guide: docs/USER_SECURITY_GUIDE.md ⭐ NEW — Privacy guide for end users
  • Venue age rules: docs/engineering/VENUE_AGE_RULES.md — Age verification without exposing PII
• Wave-to-Meet feature: ⭐ NEW
  • Quick start: docs/features/wave/WAVE_QUICK_START.md
  • Full documentation: docs/features/wave/WAVE_TO_MEET.md
  • Feature summary: docs/features/wave/FEATURE_SUMMARY.md
  • Beacon colors: docs/features/wave/BEACON_COLORS.md
  • Testing guide: docs/features/wave/WAVE_TESTING_GUIDE.md
• Lantern Hub: ⭐ NEW
  • Quick start: docs/features/lantern-hub/LANTERN_HUB_QUICK_START.md
  • Full documentation: docs/features/lantern-hub/LANTERN_HUB.md
  • Implementation summary: docs/features/lantern-hub/LANTERN_HUB_SUMMARY.md
  • Global flows (light & schedule): docs/features/GLOBAL_LANTERN_FLOWS.md ⭐ LATEST
• Storybook (Component Library): ⭐ NEW
  • Live Storybook: storybook.ourlantern.app (production) | storybook.dev.ourlantern.app (development)
  • Stakeholder guide: docs/storybook/STAKEHOLDER_GUIDE.md ⭐ — How to view and interact with components (for non-developers)
  • Setup guide: docs/engineering/deployment/STORYBOOK_SETUP_GUIDE.md ⭐ — Deploy to website (Cloudflare Pages)
  • Developer docs: docs/storybook/STORYBOOK.md
  • Quick start: docs/storybook/QUICK_START.md
  • Component standards: docs/storybook/COMPONENT_STANDARDS.md
• Profile Management: ⭐ NEW
  • Privacy-first design: docs/features/profile/PRIVACY_FIRST_PROFILE.md
  • Onboarding flow: docs/features/profile/CREATE_NEW_PROFILE.md
• Safety Mechanics: ⭐ NEW
  • Safety mechanics overview: docs/features/safety/SAFETY_MECHANICS.md — Block functionality, SOS emergency system, safe spaces partnership, in-app safety education
  • Developer quick start: docs/features/safety/SAFETY_QUICK_START.md — Implementation guide with priorities, code examples, testing checklists
• Screens organization: docs/engineering/SCREENS_ORGANIZATION.md ⭐ NEW — Screens vs. components structure
• Theme & design tokens: docs/design/THEME.md
• Business & pilots:
  • Business model & monetization: docs/business/BUSINESS.md
  • San Diego pilot strategy: docs/business/PILOT_STRATEGY.md ⭐ NEW
  • Founder context & positioning: docs/business/FOUNDER_CONTEXT.md ⭐ NEW
  • Economics & unit metrics: docs/economics/ECONOMICS.md ⭐ NEW — Detailed cost breakdown, revenue models, pricing strategy, break-even analysis
  • Financial calculator: docs/economics/CALCULATOR.md ⭐ NEW — Python, Google Sheets, and spreadsheet tools to model different scenarios
• Governance & ownership: ⭐ UPDATED — Complete employee-ownership framework with philosophical foundation
  • Foundational Philosophy: docs/governance/FOUNDATIONAL_PHILOSOPHY.md ⭐ NEW — Four Pillars (housing, healthcare, education, food)
  • Governance overview: docs/governance/GOVERNANCE.md — Legal structures and mission protection
  • Quick Reference: docs/governance/GOVERNANCE_QUICK_REFERENCE.md ⭐ — One-page governance summary
  • Immutable Rights: docs/governance/IMMUTABLE_RIGHTS.md ⭐ — 10 rights that cannot be voted away
  • Employee Rights Charter: docs/governance/EMPLOYEE_RIGHTS_CHARTER.md — Constitutional rights for employee-owners
  • Shareholder-Lender Framework: docs/governance/SHAREHOLDER_LENDER_FRAMEWORK.md ⭐ — Redefines "shareholders" as lenders with zero decision power
  • Decision-Making Authority: docs/governance/DECISION_MAKING_AUTHORITY.md ⭐ — Only employees can make business decisions
  • Anti-Greed Safeguards: docs/governance/ANTI_GREED_SAFEGUARDS.md ⭐ — 21 protections against mission drift and exploitation
  • Hiring Policy: docs/governance/HIRING_POLICY.md ⭐ NEW — Max 3 interview rounds, family/friend hiring with guardrails
  • Contractor Pathway: docs/governance/CONTRACTOR_PATHWAY.md ⭐ — Contractor vs. employee distinction and conversion
  • Legal Compliance: docs/governance/LEGAL_COMPLIANCE.md ⭐ — Legal requirements, entity types, compliance checklist
• Security & incident response: docs/governance/SECURITY.md, security/
• Vulnerability disclosure: security/VULNERABILITY_DISCLOSURE.md ⭐ UPDATED — How to report security issues
• Contributing guidelines: docs/CONTRIBUTING.md

Testing & Quality

• Unit tests: Vitest + Testing Library (vitest.config.js, test.setup.js, src/__tests__/)
• Run tests: npm test
• Lint/format: npm run lint, npm run lint:fix, npm run format, npm run format:check
• Coverage: npm run test:coverage
• CI: Not yet included; see docs/CONTRIBUTING.md for expectations and add workflows when expanding functionality.

Commands

• Install: npm install
• Dev: npm run dev
• Build: npm run build
• Preview: npm run preview
• Storybook: npm run storybook
• Test: npm test

If a document is missing or outdated, open an issue or PR with a proposed update.