GitHub Repository Analysis Bot

A Discord bot that analyzes GitHub repositories and provides detailed insights about their authenticity, maintenance, and overall quality.

Features

• Repository activity analysis (commits, PRs, issues)
• Code uniqueness verification
• Documentation quality assessment
• Security policy checking
• Update frequency monitoring
• Popularity metrics tracking
• Maintenance metrics evaluation
• Authenticity scoring system
• Multi-language support (English, Spanish, French)

Prerequisites

• Node.js >= 16.0.0
• Redis server
• Discord Bot Token
• GitHub Personal Access Token

Installation

1. Clone the repository:

git clone https://github.com/yourusername/github-repository-analysis-bot.git
cd github-repository-analysis-bot

2. Install dependencies:

npm install

3. Copy the environment template and configure your settings:

cp .env_template .env

Edit the .env file with your credentials:

DISCORD_TOKEN=your_discord_bot_token_here
CLIENT_ID=your_discord_client_id_here
GITHUB_TOKEN=your_github_personal_access_token_here

Usage

1. Start the bot:

npm start

2. For development with hot-reload:

npm run dev

3. Build the TypeScript code:

npm run build

Discord Commands

• /check <repository> - Get a quick analysis of a GitHub repository
• /detailed <repository> - Get a detailed analysis with all metrics

Example:

/check facebook/react
/detailed vercel/next.js

Configuration

The bot can be configured using environment variables:

• DISCORD_TOKEN: Your Discord bot token
• CLIENT_ID: Your Discord application client ID
• GITHUB_TOKEN: GitHub personal access token
• REDIS_URL: Redis connection URL (default: redis://localhost:6379)
• LOG_LEVEL: Logging level (default: info)
• DEFAULT_LANGUAGE: Default language for responses (default: en)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.

Acknowledgments

• Discord.js for the Discord API integration
• Octokit for the GitHub API integration
• The amazing open-source community