Skip to content

QUICK_START.md

Latest commit

 

History

History
107 lines (80 loc) · 2.14 KB

QUICK_START.md

File metadata and controls

107 lines (80 loc) · 2.14 KB
Raw

Quick Start Guide

First Time Setup

# 1. Install dependencies
pnpm install

# 2. Run development server
pnpm dev

# 3. Open browser to http://localhost:5173

Daily Development

# Make sure you're on main
git checkout main

# Make changes to code...

# Test before committing
pnpm test
pnpm run type-check

# Commit and push
git add .
git commit -m "feat: your change description"
git push origin main

GitHub Actions will automatically:

  • ✅ Run tests
  • ✅ Check types
  • ✅ Try to build

Check the ✅ or ❌ on GitHub before deploying.

Deploying to Production

# When ready to release to users
git checkout prod
git merge main
git push origin prod

GitHub Actions will automatically:

Available Commands

pnpm dev            # Start dev server
pnpm build          # Build for production
pnpm preview        # Preview production build locally
pnpm test           # Run tests once
pnpm test:watch     # Run tests in watch mode
pnpm test:ui        # Open test UI
pnpm run type-check # Check TypeScript types

Branch Strategy

  • main: Development branch - push here for daily work
  • prod: Production branch - merge here to deploy to users

Need More Info?

  • Full workflow explanation: See GIT_WORKFLOW.md
  • GitHub setup: See GITHUB_SETUP.md
  • Contributing: See CONTRIBUTING.md
  • Changelog: See CHANGELOG.md

Troubleshooting

Tests failing?

pnpm test:watch  # Run in watch mode to see what's failing

Type errors?

pnpm run type-check  # See all type errors

Build failing?

pnpm build  # Try building locally first

Site not updating after deploy?

  • Hard refresh: Ctrl+Shift+R (Windows) or Cmd+Shift+R (Mac)
  • Wait 2-3 minutes for GitHub Pages CDN

Getting Help

  1. Check GIT_WORKFLOW.md for detailed explanations
  2. Check GitHub Actions tab for error details
  3. Open an issue with:
    • What you tried
    • What happened
    • Error messages
    • Link to failed Action (if applicable)