Environment Setup

Instructions for setting up the Mystery Gift development environment.

Prerequisites

  • Node.js 20+
  • pnpm (package manager)
  • Python 3.8+ (for MkDocs docs)
  • Git

Repository Setup

  1. Clone with submodules:
git clone --recurse-submodules https://github.com/anomalyco/mystery-gift.git
cd mystery-gift
  1. Install dependencies:
pnpm install
  1. Generate Prisma client:
cd packages/database && pnpm prisma:generate
  1. Run database migrations: 
    pnpm prisma:migrate dev

Environment Variables

Each service has its own .env.example file. Copy the example file and fill in your credentials:

# Example for livestream server
cp apps/livestream/server/.env.example apps/livestream/server/.env

# Example for marketplace api
cp apps/marketplace/api/.env.example apps/marketplace/api/.env

Edit each .env file to add your own credentials for external services.

Running Services

Start all services:

pnpm dev

Start specific apps:

pnpm dev --filter=livestream-server
pnpm dev --filter=livestream-overlay
pnpm dev --filter=marketplace-api
pnpm dev --filter=marketplace-client
pnpm dev --filter=miss

Documentation

Build and preview documentation:

cd apps/docs && source venv/bin/activate && mkdocs serve

Next Steps