Skip to content

README.md

Latest commit

 

History

History
114 lines (82 loc) · 3.74 KB

README.md

File metadata and controls

114 lines (82 loc) · 3.74 KB

Summer of Bitcoin Organizations

MIT License PRs Welcome Made with Love

A site for exploring and analyzing the organizations participating in Summer of Bitcoin — filter them by year, technology, topics, and more.

Summer of Bitcoin

✨ Features

  • Browse all Summer of Bitcoin organizations across all years (2021–2025)
  • Filter by year, technology stack, and topics
  • View detailed org pages with project history graphs and student project info
  • Find first-time organizations with a dedicated toggle
  • Search organizations by name
  • Responsive design — works great on desktop and mobile

🛠️ Tech Stack

🚀 Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/Jaydeep869/SOB_Organizations.git
cd SOB_Organizations

# Install dependencies
npm install

# Start the development server
npm run dev

The app will be available at http://localhost:5173/.

Build for Production

npm run build
npm run preview

📂 Project Structure

├── src/
│   ├── assets/           # Images and static assets
│   ├── components/       # Reusable UI components
│   │   ├── FilterBlock.jsx
│   │   ├── OrgCard.jsx
│   │   └── Sidebar.jsx
│   ├── pages/            # Route pages
│   │   ├── Home.jsx
│   │   └── OrgDetail.jsx
│   ├── utils/            # Utility functions
│   │   └── slugify.js
│   ├── data.js           # Organization data
│   ├── theme.js          # MUI theme configuration
│   └── main.jsx          # App entry point
├── public/               # Public static files
├── index.html
├── vite.config.js
└── package.json

🤝 Contributing

Contributions are most welcome! Whether it's reporting a bug, suggesting a feature, or sending a pull request — every contribution helps.

Please read the Contributing Guide to get started.

📊 Data

The organization data is sourced from the Summer of Bitcoin website, including:

  • Organization names and GitHub links
  • Participation years and project counts
  • Student names and project descriptions (where available)
  • Technologies and topics

If you notice any incorrect or missing data, please open an issue or submit a PR to update src/data.js.

🙏 Credits & Acknowledgements

  • Summer of Bitcoin — For running this incredible program and making all the data publicly available.
  • GSoC Organizations by @nishantwrp — This project was heavily inspired by this amazing GSoC organizations explorer. Huge thanks for the idea and the open-source spirit!

📝 License

This project is licensed under the MIT License.

If you find this useful, please ⭐ star the repo — it helps!