Skip to content

bsoc-bitbyte/Exam-Bud

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

89 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š EXAM-BUD

Exam-Bud Banner

GitHub Stars GitHub Forks GitHub issues Contributors Made with Love

built with love badge works on my machine badge built by developers badge

πŸ” Overview

Exam-Bud is a collaborative platform developed by students of IIITDM Jabalpur to solve the age-old problem of scrambling for study materials during exam season. Built during the BitByte Summer of Code event, this platform aims to create a centralized hub where students can:

  • πŸ“ Share and access lecture notes and study materials
  • πŸ“š Upload and download previous year question papers
  • πŸ’¬ Participate in dedicated discussion forums for each subject
  • πŸ”” Get notifications about new materials in subscribed courses

🧠 Features That Actually Solve Real Problems

πŸ“ Notes Sharing

Found someone's notes from last year that saved your life? Pay it forward. Upload and share notes with your classmates. Because not all heroes wear capes, some just share PDFs.

πŸ’¬ Discussion Forums

That moment when you're stuck on a problem at 2 AM and everyone else is awake too because #ExamSeason. Ask questions, get answers, share memes. We're all in this together.

🀝 Collaborative Study

Form study groups, share resources, and pretend you've been studying all semester when you've actually been binging Netflix. No judgment here.

πŸ“± Mobile-Friendly

Access notes from anywhere - whether you're at the library pretending to study, or in bed actually studying. We've got you covered.

πŸ” Secure Access

Only verified IIITDM students can join. No professors allowed (we're kidding... maybe). What happens in Exam-Bud stays in Exam-Bud.

πŸš€ Lightning Fast

Because when you're looking for notes 10 minutes before the exam, every second counts. We've optimized for panic-browsing.


πŸ› οΈ Tech Stack

Our tech stack is as robust as your excuses for not studying earlier:

Frontend Backend Database DevOps
React Node.js PostgreSQL Docker
TailwindCSS Express GitHub Actions
JavaScript

πŸ—οΈ Project Architecture

Project Structure

🎨 Design & UI

Our UI is designed with the sleep-deprived student in mind - simple, intuitive, and caffeine-friendly.


🚦 Getting Started

Wants to setup locally? check out SETUP.md

Prerequisites

  • Docker (because we're fancy like that)
  • Node.js (the backbone of modern web)

The "I Just Want It Working" Quick Setup

# Clone the repo (like copying your friend's notes)
git clone https://github.com/bsoc-bitbyte/Exam-Bud.git

# Enter the project directory (like entering exam hall - with fear and trembling)
cd Exam-Bud

# In the backend folder, rename .env.sample to .env (the digital equivalent of finding the cheat sheet)
cd backend
mv .env.sample .env
npm install

# Go back to root (like going back to basics when you're confused in an exam)
cd ..

# Enter frontend directory (frontend = what people actually see, like your face during an exam)
cd frontend
npm install

# Go back to root again (you're getting good at this navigation thing!)
cd ..

# Fire up Docker (like firing up your brain cells at 3 AM)
docker compose up --build -d

# Open your browser and go to:
# localhost:3001

If you see the app running, congratulations! You've done more work setting this up than you probably did studying for your last exam!

πŸ§ͺ Techstack Learning Resources

Feeling lost? Here are some resources:

🀝 Contributing (Because We Need All The Help We Can Get)

Want to contribute? Amazing! Check out our CONTRIBUTING.md guide.

Remember:

  • We use conventional commits (feat, fix, docs, etc.)
  • We welcome all contributions, especially from those procrastinating on their own studies
  • No contribution is too small (except maybe that one assignment you didn't do)

πŸ’­ Quotes to Make You Feel Better About Procrastinating

"I don't need Stack Overflow, I am Stack Overflow." β€” Every CS student right before a major bug

"Software is like sex: it's better when it's free." β€” Linus Torvalds

"I am a lazy person, which is why I like open source, for other people to do work for me." β€” Also Linus Torvalds (he's a gold mine)

"It compiles; ship it!" β€” Every developer ever, moments before disaster

πŸ“Š Project Stats (Because Numbers Make Everything Look Official)

✨ Stars: 10 (and counting!)
🍴 Forks: 34 (more than the forks in the college Nescafe)
πŸ‘€ Watchers: 1
πŸ‘¨β€πŸ’» Contributors: 4 amazing individuals who probably should be studying

πŸ“œ License

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

In human terms: Feel free to use, modify, and distribute this code, just don't blame us if it doesn't work as expected (much like those last-minute notes you borrowed).

πŸ‘₯ Maintainers


Made with ❀️ and a concerning amount of caffeine by students, for students

Copyright Β© 2025 BSOC-BitByte | "Because sleep is overrated during exam season"

ctrl+c ctrl+v

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 11

Languages