Github Repository Scanner

The GitHub Repository Scanner provides detailed analysis of repositories, including commit patterns, contributor statistics, and potential security concerns.

How to use GitHub Scanner

1. Start the Process – Type "GitHub scan" to initiate the scan.

2. Enter the Repository URL – The AI will prompt you to input the GitHub repository URL you want to analyze.

3. Scanning Begins – Once you submit the URL, the system will thoroughly analyze the repository for potential risks.

4. Review the Report – After the scan is complete, you’ll receive a detailed report covering security findings, code quality issues, and other key insights.

API Endpoint

This section defines the structure of the GitHubScanResponse which is an extension of APIResponse. It contains detailed metadata about a GitHub repository. The key elements include:

• repoInfo: Provides comprehensive details:

  • name, owner, description: Basic info about the repository.

  • stars, forks, open_issues: Popularity and activity indicators.

  • created_at, last_push: Timeline information.

  • size, language: Technical specifications.

  • languages: Breakdown of language usage.

  • commits_count, commits_per_day: Insights into development activity.

  • contributors_count, days_since_creation: Community engagement metrics.

• warnings: Array of warning strings.

• red_flags: Array of critical issues or concerns.

// Request
const scanGitHubRepo = async (repoUrl: string): Promise<GitHubScanResponse> => {
  const response = await fetch(`${endpoints.socialMetrics}/github-scan`, {
    method: 'POST',
    body: JSON.stringify({ repoUrl })
  });
  return response.json();
};

interface GitHubScanResponse extends APIResponse<{
  repoInfo: {
    name: string;
    owner: string;
    description: string;
    stars: number;
    forks: number;
    open_issues: number;
    created_at: string;
    last_push: string;
    size: number;
    language: string;
    languages: { [key: string]: number };
    commits_count: number;
    commits_per_day: number;
    contributors_count: number;
    days_since_creation: number;
  };
  warnings: string[];
  red_flags: string[];
}> {}