OpenSource-Compass

KO | EN

gitlite — search

#react #ai #llm #go #android #rust #deep-learning #nodejs #java #windows #awesome #cli #pytorch #mcp

OpenSource-Compass

(★ 46)

OpenSource Compass is a beginner-friendly, community-driven platform that guides students and first-time contributors in open source. It offers Git/GitHub basics, contribution best practices, do’s and don’ts, and a hub for programs like SWOC, GSSoC, GSoC, Hacktoberfest, etc

OpenSource-Compass Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🌍 OpenSource Compass  
### Navigate Your Open Source Journey with Confidence

[![Open Source](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/sayeeg-11/OpenSource-Compass)
[![GitHub Issues](https://img.shields.io/github/issues/sayeeg-11/OpenSource-Compass)](https://github.com/sayeeg-11/OpenSource-Compass/issues)
[![GitHub License](https://img.shields.io/github/license/sayeeg-11/OpenSource-Compass)](https://raw.githubusercontent.com/sayeeg-11/OpenSource-Compass/main/LICENSE)

</div>

## ❄️ Social Winter of Code (SWOC) 2026

**Social Winter of Code (SWOC)** is a winter-long open-source program that mentors students through meaningful, real-world contributions.

### 🌟 Elite Coders Winter of Code (ECWOC) 2026

**Elite Coders Winter of Code (ECWOC)** is a beginner-friendly open-source initiative that supports students through guided mentorship and real-world project contributions.

---

## 📍 Table of Contents

- [📖 About the Project](#-about-opensource-compass)
- [🎯 Vision & Objectives](#-project-vision--objectives)
- [✨ Key Features & Learning Paths](#-key-features--learning-paths)
- [🛠 Tech Stack](#-tech-stack)
- [📂 Project Structure](#-project-structure)
- [🚀 Getting Started](#-getting-started)
- [👥 Team & Mentors](#-team--swoc26)
- [📜 License](#-license)

---

## 📌 About OpenSource Compass

> [!NOTE]
> **Think of this as your friendly roadmap into open source 🌱**

Your **ultimate beginner-friendly guide** to open source.  
No jargon. No confusion. Just clear steps to help you start contributing with confidence.

---

## 🎯 Project Vision & Objectives

* 🏁 Simplify **Git & GitHub** for beginners
* 🔄 Explain real-world **open-source workflows**
* 📚 Share **curated learning resources**
* 🏆 Prepare contributors for **SWOC, GSSoC, GSoC & Hacktoberfest**
* 🤝 Foster an **inclusive & welcoming community**

---

## ✨ Key Features & Learning Paths

---

## 🛠 Tech Stack

---

## 📂 Project Structure

<details>
<summary>Click to view Project File Structure</summary>

```
OPENSOURCE-COMPASS/
├── .github/
│   ├── ISSUE_TEMPLATE/
│   ├── workflows/
│   └── PULL_REQUEST_TEMPLATE.md
├── backend/
│   ├── config/
│   ├── controllers/
│   ├── middleware/
│   ├── models/
│   ├── routes/
│   └── server.js
├── frontend/
│   ├── assets/templates/
│   ├── css/
│   ├── data/
│   ├── js/
│   ├── library/
│   ├── pages/
│   └── node_modules/
├── public/
├── 404.html
├── index.html
└── README.md
```
</details>

---
### Screenshots

#### Home Page
[![Home Page](https://raw.githubusercontent.com/sayeeg-11/OpenSource-Compass/main/frontend/assets/templates/Updated%20Homepage.png)](./frontend/assets/templates/Updated%20Homepage.png)

#### Guide Page
[![Guide Page](https://raw.githubusercontent.com/sayeeg-11/OpenSource-Compass/main/frontend/assets/templates/guides.png)](frontend/assets/templates/guides.png)

#### Programs Page
[![Programs Page](https://raw.githubusercontent.com/sayeeg-11/OpenSource-Compass/main/frontend/assets/templates/Programs.png)](frontend/assets/templates/Programs.png)

---
## 👥 Team — SWOC’26

### 🛠 Project Admin

| Name | Role | GitHub | LinkedIn |
|----|----|------|---------|
| **Sayee Gosavi** | Project Admin | [@sayeeg-11](https://github.com/sayeeg-11) | [LinkedIn](https://linkedin.com/in/sayee-gosavi11)|

> Responsible for project direction, reviews, and overall quality.

---

### 🧑‍🏫 Mentors

| Name | Role | GitHub | LinkedIn |
|----|----|------|---------|
| **Sameera Jape** | Mentor | [@sameera731](https://github.com/sameera731) | [LinkedIn](https://linkedin.com/in/sameera-jape)  |
| **Satyam Pandey** | Mentor | [@Satyam12x](https://github.com/Satyam12x) | [LinkedIn](https://linkedin.com/in/satyam-pandey-301061272) |
| **Gopichand** | Mentor | [@Gooichand](https://github.com/Gooichand) | [LinkedIn](https://linkedin.com/in/gopichand-d-269709287) |

> Mentors guide contributors, review pull requests, and provide feedback throughout SWOC’26.

---

## 🌍 Community & Contributors

### 💖 Contributors  
Thanks to these amazing people who have contributed to **OpenSource Compass** ✨

<br/>

### ⭐ Project Support

[![Stars](https://img.shields.io/github/stars/sayeeg-11/OpenSource-Compass?style=social)](https://github.com/sayeeg-11/OpenSource-Compass/stargazers)
&nbsp;&nbsp;
[![Forks](https://img.shields.io/github/forks/sayeeg-11/OpenSource-Compass?style=social)](https://github.com/sayeeg-11/OpenSource-Compass/network/members)

</div>

---

## 🤝 Contribution Guidelines (SWOC’26)

> [!IMPORTANT]
> **Please read our detailed [CONTRIBUTING.md](CONTRIBUTING.md) guide before you start!** 
> It covers everything from setup to pull request standards.

### How to Contribute

1.  Browse the **[Issues](https://github.com/sayeeg-11/OpenSource-Compass/issues)** section
2.  Comment on the issue you want to work on
3.  Wait for assignment
4.  Create a new branch
5.  Make your changes
6.  Open a Pull Request

> [!IMPORTANT]
> **Do not create a PR without issue assignment.**
> Unsolicited PRs may be closed. Always follow mentor feedback and repository guidelines.

📄 Refer to issue #23 – Important Contributing Guidelines for OpenSource Compass

---

## 🚀 Getting Started

Follow these steps to set up the project locally and start contributing.

### 1️⃣ Fork the Repository
Click the **Fork** button on GitHub to create a copy under your account.

### 2️⃣ Clone the Repository
```bash
git clone https://github.com/YOUR-USERNAME/OpenSource-Compass.git
cd OpenSource-Compass
 ```

### 3️⃣ Run the Project (One-Command Setup)

For a quick and easy start, we provide a one-command setup script that automatically installs all dependencies, sets up your environment variables, and starts both the backend API and frontend web app.

**For Windows Users (Command Prompt):**
```cmd
setup.bat
```

**For Windows Users (PowerShell):**
```powershell
powershell -ExecutionPolicy Bypass -File .\setup.ps1
```

**For Mac/Linux Users:**
```bash
chmod +x setup.sh
./setup.sh
```

**What this does:**
- Installs backend dependencies.
- Copies `.env.example` to `.env`.
- Starts the backend server.
- Starts `live-server` which will automatically open `http://127.0.0.1:5500` in your default browser.

*(Alternatively, you can manually use the **Live Server** extension in VS Code if you only plan to edit the frontend).*

### 4️⃣ Start Contributing
Make changes → Test → Push → Create Pull Request

---

## 💡 How You Can Contribute?

---

## 📋 Submitting Your Changes

### Step 1: Create a New Branch
```bash
git checkout -b feature/your-feature-name
```
### Step 2: Make Your Changes
Implement your updates following project guidelines.
### Step 3: Test Locally
Ensure everything works correctly before committing.
### Step 4: Commit Your Work
```bash
git add .
git commit -m "Brief description of your changes"
```
### Step 5: Push to GitHub
```bash
git push origin feature/your-feature-name
```
### Step 6: Create a Pull Request
Go to GitHub and click "Create Pull Request". Done! 🚀

---

## ✅ Do's and ❌ Don'ts

---

## 💝 Code of Conduct

**Be awesome. Be kind. Be respectful.**

We don't accept:
* 😠 Rudeness or bullying
* 👎 Mean comments
* 🚫 Discrimination
* 💬 Hateful language

> [!TIP]
> **Everyone is welcome here!** 🌈

---

## 🌟 Open Source Programs

Join these cool programs and get recognized! 🏆

* **SWOC** - Social Winter of Code 🎿
* **GSSoC** - GirlScript Summer Code 👩‍💻
* **GSoC** - Google Summer of Code 🚀
* **Hacktoberfest** - October fest! 🎃

---

## 📚 Learn More

### Right Here:
* Getting Started Guide
* Git & GitHub Tutorial
* Programs Hub
* Video Library
* Tips & Tricks

### Out There:
* [GitHub Basics](https://guides.github.com)
* [Git Tutorial](https://git-scm.com)
* [Web Dev Docs](https://developer.mozilla.org)
* [Open Source Tips](https://opensource.guide)

---

## 🐛 Found a Bug?

We want to know! Tell us! 📢

1.  Check if someone already reported it
2.  Click "New Issue" on GitHub
3.  Write what happened
4.  We'll fix it! ✅

---

## 🎁 Cool Ideas to Contribute

* 📝 Add more program guides
* 🎨 Make the design cooler
* 📱 Fix mobile issues
* 🎥 Add video tutorials
* 🌍 Translate to other languages
* ⭐ Share your success story

---

## 🚀 What's Coming Next?

We're planning:

* 📱 Mobile app
* 👤 User accounts
* 💬 Forums & discussions
* 🏅 Achievement badges
* 🌐 Many languages
* 🤖 AI helper

---

## 👥 Join Us!

### Love what we do?

* ⭐ Give us a star on GitHub!
* 🍴 Fork and contribute
* 💬 Share feedback
* 📣 Tell your friends

---

## 📜 License

**MIT License** = You can use, modify, and share freely! 🎉

---

## 🙏 Special Thanks

Big thanks to everyone contributing! You make this awesome! 💖

---

## ❓ Need Help?

* 📧 Open an issue on GitHub
* 💬 Join our discussions
* 📚 Check our guides

---

## 🚀 Quick Links

[Repository](https://github.com/sayeeg-11/OpenSource-Compass) | [Issues](https://github.com/sayeeg-11/OpenSource-Compass/issues) | [Pull Requests](https://github.com/sayeeg-11/OpenSource-Compass/pulls)

---

## 🌐 Connect With Us

Join our growing community! Connect with us on **Discord** for:

- 💬 Real-time discussions and support  
- 🚀 Project updates and announcements  
- 💡 Feature suggestions and feedback  
- 🤝 Collaboration opportunities

</div>

---

## ❤️ Made with Love for the Open Source Community

**Let's make open source awesome for everyone!**

⭐ Please star if this helps you! ⭐

</div>

OpenSource-Compass

OpenSource-Compass Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

OpenSource-Compass

OpenSource-Compass Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README