Get comprehensive health reports for your FOSS projects with detailed metrics and scoring.
- GitHub API integration for live project data
- Comprehensive health scoring algorithm
- Clone-based repository analysis for deeper insights
- Smart caching system to minimize API calls
- REST API with multiple endpoints
- One-click Vercel deployment
Deploy in seconds or run locally:
# Clone and run locally
git clone https://github.com/shravan20/foss-vital.git
cd foss-vital
npm install
npm run devAPI will be available at http://localhost:3000
Projects are scored across four key areas:
- Activity (30%) - Commit frequency, issue resolution, PR merge time
- Community (25%) - Contributors, contribution distribution
- Maintenance (25%) - Issue close rate, PR merge rate
- Documentation (20%) - README, LICENSE, contributing guides
Overall score is a weighted average of these dimensions (0-100).
| Category | Supported Tools / Languages |
|---|---|
| Language Support | JavaScript, Python, Ruby, Go, Rust, PHP, Java, and more |
| CI/CD Detection | GitHub Actions, Travis CI, CircleCI, Jenkins |
| Testing Frameworks | Jest, Mocha, PyTest, RSpec, PHPUnit, etc. |
| Linting Tools | ESLint, Pylint, Prettier, RuboCop, golangci-lint |
| Dependency Analysis | package.json, requirements.txt, Gemfile, go.mod, Cargo.toml, etc. |
| Security & Coverage | - Vulnerability estimation based on dependencies - Test coverage via heuristics - Live data from GitHub API |
Clone-Based Analysis - For detailed metrics, we use optimized repository cloning:
- Shallow clone (
--depth 1) to temporary directory - Local file analysis for configs and dependencies
- Comprehensive dependency file parsing
- 7-day caching to minimize repeated clones
- Automatic cleanup after analysis
- Significantly reduces API calls
# Basic project info
curl "https://your-deployment.vercel.app/api/projects/owner/repo"
# Health score
curl "https://your-deployment.vercel.app/api/health/owner/repo"
# Complete analysis
curl "https://your-deployment.vercel.app/api/projects/owner/repo/complete"| Variable | Default | Description |
|---|---|---|
GITHUB_TOKEN |
- | GitHub token for higher rate limits |
NODE_ENV |
development |
Environment mode |
CORS_ORIGINS |
* |
Allowed CORS origins |
PORT |
3000 |
Server port (local only) |
- Without token: 60 requests/hour per IP
- With token: 5,000 requests/hour
- Recommendation: Use GitHub token for production
- Fork the repository
- Create feature branch (
git checkout -b feature/name) - Commit changes (
git commit -m 'Add feature') - Push to branch (
git push origin feature/name) - Open Pull Request
Read CONTRIBUTING.md for detailed guidelines.