Skip to content

ewa-edun/HackBuddy

Repository files navigation

HackBuddy – Stay on Track, Crush the Hackathons! 💪🎨🥇

Welcome to HackBuddy! Your ultimate companion for hackathon success. Whether you're a hackathon rookie or a seasoned pro, HackBuddy has the tools to keep you organized, motivated, and submission-ready. Let’s dive into the world of hackathon greatness!

Introduction 🎮

HackBuddy is a web app designed to enhance your hackathon experience. From tracking your upcoming hackathons to generating fun excuses and ensuring your submissions are on point, HackBuddy has your back.

“Hackathons are chaotic; HackBuddy makes them manageable!” – Every developer ever🤭🤭.


Features 🔬

Here’s what HackBuddy offers:

1. Hackathon Tracker 🗒

  • Add, edit, and delete your hackathons with ease.
  • Track their status: Upcoming, Ongoing, or Completed.
  • Never lose track of your deadlines again!

2. Excuse Generator 🎤

  • Feeling stuck during a hackathon? Get hilarious and relatable excuses to lighten the mood.
  • Practical tips to unblock your progress.

3. Submission Ready Checklist 🔧

  • Never miss a critical step before submitting your project.
  • Mark tasks as complete and ensure everything is polished.

4. What’s Next Page 🚀

  • Reflect on your hackathon journey.
  • Plan for your next big adventure with motivational content and future project ideas.

Tech Stack 🤖

Frontend:

  • React.js: For dynamic and interactive user interfaces.
  • Vanilla CSS : For a sleek, responsive design.
  • React Router: For seamless navigation.

Backend:

  • Flask: Powers the backend with RESTful APIs.
  • SQLite: A lightweight database to store hackathon details, excuses, and checklist items.

APIs:

  • CRUD API for hackathons.
  • Excuse Generator API.
  • Checklist API.

Hosting:


Installation 🌎

Follow these steps to set up HackBuddy on your local machine:

Prerequisites

  • Node.js and npm installed.
  • Python 3 and pip installed.

Steps

  1. Clone the repository:

    git clone https://github.com/ewa-edun/HackBuddy.git
    cd HackBuddy
  2. Install Frontend Dependencies:

    npm install
  3. Install Backend Dependencies:

    cd Backend
    pip install -r requirements.txt
  4. Run the Backend Server:

    flask run
  5. Run the Frontend Server:

    npm start
  6. Open Your Browser: Navigate to http://localhost:3000 to access HackBuddy.


Usage 🔄

Navigation

  • Hackathon Tracker:
    • Add your hackathons and view their statuses.
  • Excuse Generator:
    • Access fun excuses when a hackathon is ongoing.
  • Submission Checklist:
    • Review and complete tasks as deadlines approach.
  • What’s Next Page:
    • Plan your next adventure post-hackathon.

Contributing 📚

I’d love your help! Here’s how you can contribute:

  1. Fork the repository.
  2. Create a feature branch:
    git checkout -b feature-name
  3. Commit your changes:
    git commit -m "Added feature-name"
  4. Push to the branch:
    git push origin feature-name
  5. Open a Pull Request.

References

Icons are from Font Awesome. Colors were decided with Coolors.


HackBuddy – Stay on Track, Crush the Hackathons! Let us know how it worked for you and share your success stories! 🎨🎉

About

Stay on Track, Crush the Hackathons

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published