💡 Inspiration
Many beginner developers push projects to GitHub with no description, no topics, and a thin README. This hurts their chances with recruiters who skim repos quickly. I wanted to build a tool that helps developers see their repositories through a recruiter's eyes and fix them instantly.
💻 What it does
GitHub Repo Auditor automatically scans any public GitHub repository via the GitHub API and gives it an instant, actionable Hireability Score out of 100. It checks for:
- Project Description (20 points)
- Topics/Tags (20 points)
- README existence (40 points)
- README size/detail (20 points)
🛠️ How I built it
To keep the tool lightning-fast and accessible, I built it as a purely static website:
- Frontend: HTML5, CSS3, and Vanilla JavaScript.
- API: GitHub REST API (Client-side fetch).
- Architecture: No backend required! It runs completely in the browser, making it incredibly fast and easy to host anywhere.
⚠️ Challenges I ran into
One of the main challenges was handling the GitHub API rate limits for unauthenticated requests and ensuring the UI provides clear, friendly error messages when a user types an invalid or private repository URL.
🏆 Accomplishments that I'm proud of
I am incredibly proud of building a fully functional, bilingual (English/Arabic) web tool from scratch and deploying it successfully for the FirstCommit hackathon. Designing the terminal-like UI was also a fun and rewarding experience!
Built With
- css3
- github-api
- html5
- javascript
Log in or sign up for Devpost to join the conversation.