Skip to content

HikaruEgashira/github-golf

Repository files navigation

GitHub Golf ๐ŸŒ๏ธ

An interactive quiz application to test and improve your Git knowledge. Built with Vite and TypeScript, featuring smooth animations and visual feedback.

Features

  • ๐ŸŽฏ Interactive GitHub Search quiz
  • โœจ Visual feedback with confetti effects for correct answers
  • ๐Ÿ–ผ๏ธ Explanatory images for better understanding
  • ๐ŸŽจ Smooth animations using Framer Motion
  • ๐Ÿ“ฑ Responsive design
  • ๐ŸŽฎ Interactive UI components

Tech Stack

  • Vite
  • TypeScript
  • Framer Motion
  • Canvas Confetti
  • Lucide React Icons

Getting Started

  1. Clone the repository:
git clone https://github.com/HikaruEgashira/github-golf.git
  1. Install dependencies:
bun install
  1. Run the development server:
bun run dev
  1. Open http://localhost:3000 in your browser.

Project Structure

โ”œโ”€โ”€ globals.css         # Global styles
โ”œโ”€โ”€ components/
โ”‚   โ”œโ”€โ”€ quiz/           # Quiz-specific components
โ”‚   โ””โ”€โ”€ ui/             # Reusable UI components
โ”œโ”€โ”€ hooks/              # Custom React hooks
โ””โ”€โ”€ lib/
    โ””โ”€โ”€ quiz-data.ts    # Quiz questions and answers

Quiz Features

  • Multiple choice questions about GitHub Search
  • Immediate feedback on answers
  • Detailed explanations with visual aids
  • Progress tracking
  • Character-based questions for engaging learning

Contributing

Contributions are welcome! Feel free to submit issues and pull requests.

License

MIT License