Skip to main content

overlevered_server

Firebase Cloud Functions server for the overlevered_app.

Overview​

The overlevered_server provides:

  • Firebase Cloud Functions backend
  • Stripe payment processing
  • API endpoints for the overlevered_app

Technology Stack​

  • Runtime: Node.js 20
  • Framework: Firebase Functions 5.x
  • Language: TypeScript 5.x
  • Payments: Stripe
  • Database: Firebase Admin SDK

Getting Started​

Prerequisites​

  • Node.js 20
  • Bun (preferred) or npm
  • Firebase CLI
  • Firebase project

Setup​

  1. Install dependencies:

    cd functions
    bun install

  2. Build TypeScript:

    bun run build

  3. Start Firebase emulators:

    bun run serve

Key Commands​

Development​

  • bun run serve - Start Firebase emulators
  • bun run devStart - Start with nodemon
  • bun run build - Build TypeScript
  • bun run watch - Watch TypeScript files

Deployment​

  • bun run deploy - Deploy to Firebase
  • bun run logs - View function logs

Stripe​

  • bun run stripe:listen - Listen to Stripe webhooks locally

Architecture​

The server consists of Firebase Cloud Functions:

  • API endpoints for the overlevered_app
  • Stripe webhook handlers
  • Business logic for licenses and payments

Environment Variables​

Configured via Firebase Functions config or .env:

  • Stripe API keys
  • Firebase project configuration

Documentation​