McBroken

The project idea is inspired by McBroken.com made by rashiq.

Features

• View the status of ice machines for McFlurry, McSundae, and milkshake products at McDonald's locations in the US, EU, and Australia.

Built With

• Turborepo - Monorepo build system
• Serverless Framework 3.x - AWS Lambda deployment
• Prisma 6.x - ORM with PostgreSQL 17
• Next.js 15 - Frontend framework (App Router + Turbopack)
• React 19 - UI library
• TailwindCSS 3.x - Styling
• Radix UI & shadcn/ui - UI Components
• Mapbox GL - Map rendering
• pnpm 10.x - Package manager

Project Structure

This project uses a monorepo structure managed by Turborepo:

apps/
├── frontend/      # Next.js 15 application - @mcbroken/frosty
├── mcall/         # Serverless: EU region - @mcbroken/mcall
├── mcus/          # Serverless: US region - @mcbroken/mcus
└── mcau/          # Serverless: AU region - @mcbroken/mcau
packages/
├── database/      # Prisma client & schema - @mcbroken/db
├── mclogik/       # Shared business logic - @mcbroken/mclogik
├── eslint-config/ # Shared ESLint config
├── typescript-config/ # Shared TypeScript config
└── serverless-config/ # Shared Serverless config

Prerequisites

• Node.js 22+ (see .nvmrc)
• pnpm 10.x (9+ minimum)
• Docker and Docker Compose for local PostgreSQL

Setup

1. Tokens: You need to have basic tokens from the McDonald's app to use their API.
2. Environment: Copy .env.dist to .env and fill in the required values.
3. Install: Run pnpm install to install all dependencies across the monorepo.
4. Database: Run docker-compose -f docker-compose.dev.yml up -d to start your local PostgreSQL database.
5. Generate Prisma Client: Run pnpm turbo run db:generate to generate the Prisma client.

Development

# Run a specific app
pnpm --filter @mcbroken/frosty dev

# Generate Prisma client (required after schema changes)
pnpm --filter @mcbroken/db db:generate

# Run type checking
pnpm check-types

# Run linting
pnpm lint

# Run tests
pnpm test

# Run the full local CI suite
pnpm verify

# Invoke a serverless function locally
cd apps/mcall
pnpm invoke functionName
pnpm invoke getItemStatus -- --data '{"countryList": ["US"]}'

GitHub Actions Deployments

Manual deployments are handled through deploy.yml with the GitHub Actions "Run workflow" button.

• Choose staging or production
• Choose all, mcall, mcus, mcau, or frontend
• Every deployment runs the full verification suite first

Required GitHub Environment Secrets

Configure the staging and production GitHub environments with these secrets:

• AWS_DEPLOY_ROLE_ARN
• DATABASE_URL
• BASIC_TOKEN_EU
• BASIC_TOKEN_EL
• BASIC_TOKEN_US
• BASIC_TOKEN_AP
• KEY
• MCALL_DEPLOYMENT_BUCKET
• MCUS_DEPLOYMENT_BUCKET
• MCAU_DEPLOYMENT_BUCKET
• SENTRY_DSN
• VERCEL_TOKEN
• VERCEL_ORG_ID
• VERCEL_PROJECT_ID
• NEXT_PUBLIC_MAPBOX_KEY

If the deployment bucket secrets are omitted, the serverless apps fall back to stage-based names like mcbrokenio-mcall-bucket-production.

Documentation

For detailed documentation, see the .ai/ directory:

• Project overview and architecture
• Development workflow
• Code patterns and conventions

Information about the different McDonalds APIs

You can find more information about the APIs here.