YeetCode App

YeetCode App is an open-source desktop application that makes competitive programming practice fun and social. Built with Electron and React, it gamifies LeetCode practice with XP, streaks, duels, and competitive features.

🌟 Like this project? Give it a star! It helps us grow and motivates continued development.

Features

🎯 Core Features

• LeetCode Integration - Connect your LeetCode account and track problem submissions in real-time
• Study Groups - Create or join groups with invite codes, compete on group leaderboards
• XP System - Earn XP for solving problems (Easy: 100 XP, Medium: 300 XP, Hard: 500 XP)
• Daily Streaks - Maintain streaks by solving daily LeetCode problems
• Real-time Leaderboards - Global, friends, group, and university leaderboards with live updates

⚔️ Competitive Features

• Duels - Challenge friends to head-to-head coding competitions
  • Normal Duels: Race to solve a problem fastest
  • Wager Duels: Bet XP on your skills (winner takes all)
  • Duel History: Track your wins/losses and completion times
• Bounty System - Time-limited challenges with XP rewards
• Daily Challenges - Complete LeetCode's daily problem for bonus XP

🏆 Leaderboards

• Friends Leaderboard - Compete with your added friends
• Group Leaderboard - See rankings within your study group
• University Leaderboard - Compare with students from your university
• My University Leaderboard - Personal ranking at your school

🎨 User Experience

• Magic Link Authentication - Secure email-based login with 6-digit codes
• Profile Customization - Set display names, add profile pictures
• Notifications - Desktop notifications for duels, bounties, and achievements
• Smooth Animations - Framer Motion animations for polished UI

Tech Stack

Frontend

• Electron - Cross-platform desktop framework
• React - UI components with hooks
• Vite - Fast build tool and dev server
• Tailwind CSS - Utility-first styling
• Framer Motion - Animation library
• Axios - HTTP client for API calls

Backend

• FastAPI - Python REST API server
• AWS DynamoDB - NoSQL database for user data
• AWS SDK - Cloud services integration
• Resend - Email service for magic links
• LeetCode GraphQL API - Problem data and validation

Development

Prerequisites

• Node.js 18+ (LTS version recommended)
• npm or yarn
• Python 3.9+ (for backend development)

Installation

# Install frontend dependencies
npm install

# Install backend dependencies (if running locally)
cd scripts/fastapi
pip install -r requirements.txt

Environment Setup

Create a .env file in the project root:

FASTAPI_URL=your_backend_url
YETCODE_API_KEY=your_api_key

Running the App

Development Mode

# Start both Electron and Vite dev server
npm run dev

# Or start Electron separately
npm run start

Production Build

# Build frontend
npm run build

# Package for distribution
npm run package

# Create installers
npm run make

Packaging Options

# Package with electron-builder
npm run package:builder

# macOS unsigned build
npm run package:mac-unsigned

# Publish (requires configuration)
npm run publish

Testing

Unit Tests (Vitest)

# Run tests
npm test

# Run tests once
npm run test:run

# Run with coverage
npm run test:coverage

# Visual test UI
npm run test:ui

E2E Tests (Playwright)

# Run E2E tests
npm run test:e2e

# Run with browser visible
npm run test:e2e:headed

# Debug mode
npm run test:e2e:debug

# Visual test UI
npm run test:e2e:ui

Run All Tests

npm run test:all

Code Quality

Formatting

# Format code with Prettier
npm run format

# Check formatting
npm run format:check

Pre-commit Hooks

The project uses lint-staged to enforce code quality:

npm run enforce-precommit-hooks

Project Structure

yeetcode-app/
├── src/
│   ├── components/          # React components
│   │   ├── leaderboard/     # Leaderboard-related components
│   │   ├── App.jsx          # Main app component
│   │   ├── WelcomeStep.jsx  # Onboarding steps
│   │   └── ...
│   ├── hooks/               # Custom React hooks
│   ├── utils/               # Utility functions
│   ├── index.js             # Electron main process
│   ├── preload.js           # Electron preload script
│   └── renderer.jsx         # React entry point
├── scripts/
│   └── fastapi/             # Python backend
│       ├── main.py          # FastAPI app
│       ├── routes/          # API endpoints
│       ├── aws.py           # AWS operations
│       └── ...
├── dist/                    # Built frontend files
├── out/                     # Packaged applications
└── tests/                   # Test files

Security

• Context Isolation - Electron security best practices enabled
• Input Validation - All user inputs validated in preload script
• API Key Protection - Keys stored securely, never exposed to frontend
• Sandboxing - Renderer process runs in sandboxed environment
• URL Whitelisting - Only approved domains (leetcode.com, wa.me, t.me) allowed

Contributing

We love contributions! 🎉 Please read our Contributing Guidelines before getting started.

Important: Before working on any feature or fix, please open an issue to discuss it first. This helps us coordinate efforts and ensure your contribution aligns with the project's direction.

Quick start for contributors:

1. Fork the repository
2. Open an issue to discuss your planned changes
3. Create a feature branch
4. Follow our code style guidelines
5. Write tests for new features
6. Submit a pull request

See CONTRIBUTING.md for detailed instructions.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold this code.

Contributors

YeetCode is developed and maintained by:

• Siddhant Modi - Co-creator & Lead Developer
• Akeenth Ramanathan - Co-creator & Lead Developer

We're grateful to all our contributors who help make YeetCode better! 🙏

License

This project is licensed under the MIT License - see the LICENSE file for details.

Copyright (c) 2025 Siddhant Modi and Akeenth Ramanathan