OpenSc0ut

Your gateway to meaningful open source contributions and developer growth.

_{Built for devs, by a dev.}

Features · Getting Started · Tech Stack · Contributing · License

---

🌟 About OpenSc0ut

Discover. Contribute. Grow.

OpenSc0ut is a modern, beautifully designed web application that helps developers seamlessly discover, evaluate, and contribute to open-source GitHub repositories from around the world.

Whether you're hunting for your very first contribution, preparing for Google Summer of Code, or searching for high-quality tools — OpenSc0ut cuts through the noise and puts the right projects right in front of you.

---

✨ Features

🔍 Global Repository Search

Find repositories by name, topic, or keyword in real-time with a powerful search interface.

⚙️ Advanced Filtering & Sorting

• Filter by multiple programming languages — JavaScript, Python, Rust, Go, and more.
• Sort by stars, forks, recent updates, or creation date.
• Ascending / descending order controls.

🤖 Repo Scout — AI-Powered Analysis

Analyze any GitHub repository's contribution readiness in seconds using Google Gemini AI.

• Instant letter grade (A → F) with an overall score out of 100.
• AI-synthesized narrative on the project's health and community.
• Direct links to "good first issues" so you know exactly where to start.

🎥 Demo:

repo-feature.mp4

🎨 Premium UI / UX

• Dark mode by default with stunning glass-morphism effects and neon accents.
• Smooth Framer Motion animations throughout.
• Fully responsive, with skeleton loading states and robust error handling.

---

🛠️ Tech Stack

Layer	Technology
Framework	Next.js (App Router)
Language	TypeScript
Styling	Tailwind CSS
Animations	Framer Motion
AI	Google Gemini API
Data	GitHub REST API
Email	Nodemailer (via Gmail SMTP)
Deployment	Vercel (Recommended)

---

🚀 Getting Started

Prerequisites

Make sure you have the following installed:

• Node.js v18 or later
• npm / yarn / pnpm
• A GitHub Personal Access Token (strongly recommended to avoid rate limits)

Installation

1. Clone the repository

git clone https://github.com/TanCodeX/OpenSc0ut.git
cd OpenSc0ut

2. Install dependencies

npm install

3. Configure environment variables

Create a .env.local file in the root directory:

# GitHub — prevents rate limiting (5,000 req/hr vs 60/hr unauthenticated)
NEXT_PUBLIC_GITHUB_TOKEN=your_github_personal_access_token

# Gemini AI — powers the Repo Scout feature
GEMINI_API_KEY=your_gemini_api_key

# Nodemailer — powers the contact form
EMAIL_USER=your_email@gmail.com
EMAIL_PASS=your_email_app_password

4. Run the development server

npm run dev

5. Open in your browser

Navigate to http://localhost:3000 and start exploring! 🎉

---

💡 GitHub API Rate Limits

Note

This project relies heavily on the GitHub API for live repository data.

Request Type	Rate Limit
Unauthenticated	60 requests / hour
Authenticated (with token)	5,000 requests / hour

Setting NEXT_PUBLIC_GITHUB_TOKEN is strongly recommended for a smooth experience.

---

🤝 Contributing

We believe in the power of community! Every contribution, no matter how small, makes a difference.

Tip

Read the Contributing Guidelines for a detailed walkthrough of the process, branch naming conventions, and coding standards.

Important

This project is released with a Code of Conduct. By participating, you agree to uphold its terms.

---

💬 Contact & Support

Have questions, feedback, or just want to say hi?

Platform	Link
GitHub	@TanCodeX
LinkedIn	Tanmay Patwary
Email	tanmaypatwary@gmail.com

---

📄 License

Distributed under the MIT License. See LICENSE for more information.

---

_{Built with ❤️ by Tanmay — for devs, by a dev.}