Skip to content

Latest commit

 

History

History
167 lines (124 loc) · 6.03 KB

File metadata and controls

167 lines (124 loc) · 6.03 KB

Debugging Dojo

🚀 Interactive Coding Challenge Platform for Learning & Debugging Skills


JavaScript React Chakra UI


📋 Overview

Educational Tool Debugging Concepts

Code Debugging Challenges is an interactive educational tool designed to enhance debugging skills through coding challenges.
It provides students and developers with a dynamic platform to identify and describe bugs in code snippets across multiple programming languages, with real-time feedback and performance tracking.


✨ Features

🎯 Core Functionality 🔧 Technical Features
Multi-Language Support: JavaScript, Java, Python, C Syntax Highlighting: Powered by Shiki with GitHub themes
Interactive Challenges: Identify bugs in code snippets Responsive Design: Mobile and desktop support with Chakra UI
Hint System: Up to 3 hints per challenge Real-time Feedback: Success/error toasts with dismissal
Accuracy Tracking: Monitor correct answers and success rate Modern UI: Dark theme with purple accents, 2xl border radius
Result Dialog: Displays final accuracy upon completion Error Handling: Robust answer validation and state management

🧮 Key Components

  • Challenge Display: Presents code snippets with bugs for users to identify.
  • Answer Submission: Allows users to describe bugs, checked against an array of valid answers.
  • Hint System: Provides up to 3 hints per challenge to assist users.
  • Accuracy Tracker: Calculates and displays the percentage of correct answers.
  • Result Dialog: Shows final accuracy and options to play again or return home after completing 5 challenges.

💻 Requirements

🛠️ Development Environment

Node.js
Node.js
Required for running the application
React
React
Framework for building the UI

📁 Required Dependencies

@chakra-ui/react → UI components and styling
shiki → Syntax highlighting for code blocks
react-router-dom → Navigation for Home button
react-icons → Icons for buttons and UI elements


🚀 Installation

Easy Setup

Step 1: Clone the Repository

git clone https://github.com/icodecedd/debugging-dojo.git
cd debugging-dojo

Step 2: Install Dependencies

# Install all required npm packages
npm install

Step 3: Run the Application

# Start the development server
npm start || npm run dev
  1. Open your browser and navigate to http://localhost:5173.
  2. Start solving coding challenges by identifying bugs in the provided code snippets.

🤝 Contributing

Contributions Welcome

We enthusiastically welcome contributions from the community! Here's how you can help improve this project:

🐛 Bug Reports 📖 Documentation 💻 Code Contributions 🎨 Enhancements
Report issues and bugs Improve README content Add new challenges Enhance UI/UX
Suggest improvements Add code comments Optimize answer checking Add animations
Test on different browsers Create tutorials Improve performance Add new languages

Contribution Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature-name)
  3. Commit your changes (git commit -m 'Add new feature')
  4. Push to your branch (git push origin feature-name)
  5. Open a Pull Request

🎓 Designed for Coding Education & Debugging Skills 🎓

Coding Education Debugging Skills

Track Project Engagement:

GitHub Repo stars GitHub forks GitHub Watchers

"Interactive coding challenges to help developers master debugging skills across multiple programming languages"