Skip to content

๐ŸŽƒ A purposely โ€œbrokenโ€ React app created for SheCodesOKCโ€™s HacktobHERfest event.

Notifications You must be signed in to change notification settings

shecodesokc/hacktober-broken-repo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

6 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŽƒ HacktobHERfest 2025 - Broken Repo Challenge! ๐Ÿ‘ฉโ€๐Ÿ’ป

Welcome to the HacktobHERfest Broken Repo - a fun, beginner-friendly React project where you can practice contributing to open source by fixing small "broken" issues! This is the perfect place to learn GitHub workflows, pull requests, and collaborative coding in a supportive environment.

๐ŸŒŸ What is this?

This is a themed React landing page for SheCodesOKC's HacktobHERfest event. The codebase has some intentional "bugs" (like typos and missing letters) that are perfect for first-time contributors to find and fix. It's designed to be educational, fun, and welcoming to everyone!

๐Ÿš€ Getting Started

Prerequisites

  • A GitHub account
  • Git installed on your computer
  • Node.js and npm installed

Setup Instructions

  1. Fork the repository ๐Ÿด

    • Click the "Fork" button in the top-right corner of this page
    • This creates your own copy of the project
  2. Clone your fork locally ๐Ÿ“ฅ

    git clone https://github.com/YOUR_USERNAME/hacktober-broken-repo.git
    cd hacktober-broken-repo
  3. Install dependencies ๐Ÿ“ฆ

    npm install
  4. Start the development server ๐Ÿƒโ€โ™€๏ธ

    npm run dev
  5. Open in your browser ๐ŸŒ

    • Visit http://localhost:5173
    • You should see the HacktobHERfest landing page!

๐Ÿ” Finding Issues

Check out the Issues tab on GitHub to find fun broken things to fix! Each issue will have:

  • A description of what's broken
  • Which file to look in
  • What the fix should be
  • Difficulty level (beginner-friendly!)

๐Ÿค How to Contribute

Step-by-Step Guide

  1. Pick an issue ๐Ÿ“‹

    • Go to the Issues tab and find something that looks fun to fix
    • Comment on the issue to let others know you're working on it
  2. Create a new branch ๐ŸŒฟ

    git checkout -b fix/your-issue-description

    Example: git checkout -b fix/header-typo

  3. Make your changes โœ๏ธ

    • Open the file mentioned in the issue
    • Fix the broken code (typos, missing letters, etc.)
    • Test your changes by refreshing the browser
  4. Add yourself to the Contributors Wall ๐Ÿ†

    • Open src/components/Contributors.jsx
    • Add your GitHub handle to the contributors array
    const contributors = [
            { name: "UserName", github: "https://github.com/USERNAME" },
    ]
  5. Commit your changes ๐Ÿ’พ

    git add .
    git commit -m "Fix: [describe what you fixed]"
  6. Push your branch โฌ†๏ธ

    git push origin fix/your-issue-description
  7. Open a Pull Request ๐Ÿ”„

    • Go to your fork on GitHub
    • Click "Compare & pull request"
    • Fill out the PR description
    • Submit your PR!
  8. Celebrate! ๐ŸŽ‰

    • Once your PR is merged, your name will appear on the Contributors Wall
    • You've just made your first open source contribution!

โœจ Fun Features

This project includes several festive elements:

  • ๐ŸŽจ Contributors Wall: See all the amazing people who've contributed!
  • ๐ŸŒˆ Festive Hover Effects: Rainbow gradients and fun animations
  • ๐Ÿ‘ป Playful "Ghost" Bugs: Intentional typos and missing letters (with fun comments!)
  • ๐ŸŽƒ Halloween Theme: Perfect for HacktobHERfest season

๐Ÿ”— Helpful Links

๐Ÿ†˜ Need Help?

  • Check the Issues tab for guidance
  • Ask questions in the issue comments
  • Join the SheCodesOKC community for support
  • Remember: Everyone was a beginner once! ๐Ÿ’œ

๐ŸŽฏ Project Structure

src/
โ”œโ”€โ”€ components/
โ”‚   โ”œโ”€โ”€ Header.jsx          # Main header with logo and title
โ”‚   โ”œโ”€โ”€ Hero.jsx            # Welcome section with CTA button
โ”‚   โ”œโ”€โ”€ Contributors.jsx    # Contributors wall
โ”‚   โ””โ”€โ”€ Footer.jsx          # Footer with organization info
โ”œโ”€โ”€ App.jsx                 # Main app component
โ””โ”€โ”€ App.css                 # Global styles

Made with ๐Ÿ’œ by SheCodesOKC

Happy contributing! ๐ŸŽƒโœจ๐Ÿ‘ฉโ€๐Ÿ’ป

About

๐ŸŽƒ A purposely โ€œbrokenโ€ React app created for SheCodesOKCโ€™s HacktobHERfest event.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published