🌍 OpenSource Compass

Navigate your Open Source journey with clarity.

---

📌 About the Project

OpenSource Compass is a beginner-friendly, community-driven web platform designed to help students and first-time contributors confidently start their open-source journey.

The project provides structured guidance on:

• Open source fundamentals
• Git & GitHub workflows
• Contribution best practices
• Common do’s and don’ts
• A centralized hub for ongoing and upcoming open-source programs

Built initially using HTML, CSS, and JavaScript, the platform focuses on simplicity, accessibility, and meaningful community contributions.

---

🎯 Project Objectives

• Help beginners understand open source in a structured way
• Reduce confusion and common beginner mistakes
• Provide a single platform for open-source program information
• Encourage quality contributions and collaborative learning
• Create an easy-to-contribute project for newcomers

---

🧩 Features

• 📘 Beginner-friendly Open Source guides
• ⚠️ Do’s and Don’ts for contributors
• 🛠 Step-by-step contribution workflow
• 🎥 Curated learning resources & videos
• 📅 Open Source Programs Hub (SWOC, GSSoC, GSoC, Hacktoberfest, etc.)
• 🤝 Community-driven content

---

🛠 Tech Stack

• HTML – Structure
• CSS – Styling & responsiveness
• JavaScript – Interactivity
• JSON – Data handling (program listings, resources)

---

📂 Project Structure

OpenSource-Compass/
│
├── index.html
├── guides/
│   ├── open-source-basics.html
│   ├── git-github.html
│
├── programs/
│   ├── swoc.html
│   ├── gssoc.html
│
├── resources/
│   ├── videos.html
│
├── css/
│   └── style.css
│
├── js/
│   └── main.js
│
├── data/
│   └── programs.json
│
├── assets/
│   └── images/
│
└── README.md

---

🚀 Getting Started

1. Fork this repository
2. Clone your fork

   git clone https://github.com/your-username/OpenSource-Compass.git
   

3. Open index.html in your browser
4. Start contributing 🎉

---

🤝 Contribution Guidelines

We welcome all kinds of contributions:

• Improving UI/UX
• Adding guides or resources
• Updating open-source program details
• Fixing bugs or improving documentation

Before contributing:

• Read CONTRIBUTING.md
• Create meaningful PRs
• Follow clean commit messages
• Be respectful and collaborative

---

📌 Contribution Types

• 🟢 Beginner: Content updates, UI fixes
• 🟡 Intermediate: New pages, JS features
• 🔵 Advanced: Architecture improvements (future scope)

---

🖼 Screenshots (Dummy)

---

📜 Code of Conduct

Please read and follow our Code of Conduct to maintain a respectful and inclusive community.

---

🌱 Future Scope

• Backend integration
• Search & filters for programs
• User profiles
• Community blog & stories
• Admin dashboard

---

💙 Community & Support

If you like this project:

• ⭐ Star the repo
• 🍴 Fork it
• 🛠 Contribute
• 📢 Share it with others

Together, let’s make open source easier for everyone 🚀

---

🏷 License

This project is licensed under the MIT License.

---

Made with ❤️ for the Open Source Community