Skip to content

Ishitham-Creative-Engineering/codebase-validator

 
 

Repository files navigation

Alignerr Codebase Validator

A lightweight tool that validates whether a GitHub repository meets Alignerr's codebase selection criteria. Paste a repo URL, get an instant verdict.

Live: https://irshadmd.github.io/codebase-validator/

What It Checks

The validator runs 10 automated checks against a repository:

Check What it looks for
Valid Git Repository Repo exists and is accessible
Primary Language Python, JavaScript, TypeScript, or Rust
Open License OSI-approved license (MIT, Apache-2.0, GPL, etc.)
Multiple Contributors 3+ contributors expected
Activity & Recognition Stars, forks, and recent push activity
Testing Practices Test files/directories (test/, tests/, .spec., etc.)
Build & Run Instructions README + build config (package.json, Cargo.toml, Makefile, etc.)
Professional Quality Not vibe-coded — checks commit history, contributor count, description
Linters & Formatters ESLint, Prettier, Ruff, Clippy, etc.
Special Files CLAUDE.md, SKILL.md, CONTRIBUTING.md

Results are displayed as Valid, Proceed with Caution, or Invalid with a detailed breakdown.

Privacy

This tool is fully client-side. No data is collected, stored, or sent anywhere.

  • Runs entirely in your browser
  • Only makes read-only calls to the public GitHub REST API
  • No backend, no database, no analytics, no cookies
  • Your GitHub token (optional) never leaves your browser

Tech Stack

  • React 18 — UI framework
  • Vite — Build tool
  • Tailwind CSS — Styling
  • Lucide React — Icons
  • GitHub REST API — Repository data
  • GitHub Pages — Hosting

Getting Started

Prerequisites

  • Node.js 18+
  • npm

Run Locally

git clone https://github.com/irshadmd/codebase-validator.git
cd codebase-validator
npm install
npm run dev

Opens at http://localhost:3000.

Build for Production

npm run build

Output goes to dist/.

Deployment

This project auto-deploys to GitHub Pages via GitHub Actions on every push to main. To deploy your own fork:

  1. Fork this repo
  2. Go to Settings > Pages > set Source to GitHub Actions
  3. Push to main — the workflow handles the rest

If you rename the repo, update the base value in vite.config.js to match.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

Author

Md Irshad

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 97.2%
  • HTML 2.2%
  • CSS 0.6%