DevVerse-SWE-Blog copilot-instructions.md

DevVerse SWE Blog - GitHub Copilot Instructions

DevVerse SWE Blog is a modern tech blog built with Next.js, React, TypeScript, MDX, Supabase, and TailwindCSS. It serves as a platform for sharing software engineering insights and technical tutorials.

CRITICAL: Always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here.

Working Effectively

Bootstrap and Setup

# Install dependencies
npm install  # Takes ~30-40 seconds, NEVER CANCEL

ENVIRONMENT VARIABLES REQUIRED:

# Create .env file or set environment variables for development
NEXT_PUBLIC_SUPABASE_URL=https://example.supabase.co  # Use stub for development
NEXT_PUBLIC_SUPABASE_ANON_KEY=example_key             # Use stub for development

CRITICAL: Without these environment variables, the application will crash with "supabaseUrl is required" error.

Development Server

# Start development server with environment variables
NEXT_PUBLIC_SUPABASE_URL=https://example.supabase.co NEXT_PUBLIC_SUPABASE_ANON_KEY=example_key npm run dev
# OR set environment variables first, then run:
npm run dev  # Server starts on http://localhost:3000

• Takes ~1-2 seconds to start
• ALWAYS set environment variables before running dev server
• App crashes without proper Supabase environment variables

Testing and Validation

# Run tests - NEVER CANCEL
npm run test  # Takes 1-2 seconds, all 11 tests should pass

# Run tests with coverage
npm run coverage  # Takes 1-2 seconds, generates coverage reports

# Run tests in watch mode
npm run test:watch

Linting and Formatting

# Format code (this is also the lint command)
npm run lint      # Runs prettier, takes ~1-2 seconds
npm run format    # Same as lint, runs prettier --write

ALWAYS run npm run format before committing changes - the CI pipeline will fail without proper formatting.

Build Process

⚠️ CRITICAL BUILD LIMITATION:

npm run build  # FAILS in sandboxed environments due to Google Fonts access

NEVER CANCEL the build command - it will timeout due to network restrictions trying to fetch fonts from fonts.googleapis.com. This is expected in sandboxed environments.