docs

RepoRadar Documentation

Welcome to the comprehensive documentation for RepoRadar - an AI-powered GitHub repository analysis platform.

📚 Documentation Overview

Quick Access

• New to RepoRadar? Start with Getting Started
• Need quick answers? Check the Quick Reference
• Have questions? See the FAQ
• Having issues? Visit Troubleshooting
• Using the API? Read API Documentation

AI Assistant

The fastest way to get help is using our AI Assistant (bottom-right corner of every page). It knows everything about RepoRadar and can answer questions instantly!

Learn more: AI Assistant Knowledge Base

📖 Documentation Sections

🚀 Getting Started

Perfect for new users and self-hosters.

• Overview - What is RepoRadar and why use it
• Installation - Setup guide for self-hosting
• Quick Start - Your first analysis in 5 minutes

Start here: Getting Started →

✨ Features

Comprehensive guides for all RepoRadar features.

• Features Overview - All features at a glance
• Repository Analysis - Understanding the 5 metrics
• Batch Analysis - Analyzing multiple repositories
• Similar Repositories - Discovery and alternatives
• Analytics Dashboard - Usage tracking (Pro)
• Subscription - Plans and billing

Explore features: Features →

🔧 API Reference

For developers integrating RepoRadar.

• API Documentation - Complete API reference
• Authentication - API keys and auth
• Repositories - Repository endpoints
• Analytics - Analytics endpoints

For developers: API Documentation →

❓ FAQ

Answers to frequently asked questions.

• FAQ - Comprehensive Q&A covering:
  • General questions
  • Account & authentication
  • Features & usage
  • Technical questions
  • Billing & payments
  • Troubleshooting
  • API & integration
  • Privacy & security

Common questions: FAQ →

🔍 Troubleshooting

Solutions to common issues.

• Troubleshooting Guide - Quick fixes
• Common Issues - Detailed solutions for:
  • Analysis problems
  • Authentication issues
  • Search & discovery
  • Performance issues
  • Export problems
  • Subscription & billing
  • Database issues (self-hosted)
  • API issues

Need help? Troubleshooting →

📋 Quick Reference

Cheat sheet for common tasks.

• Quick Reference - Quick answers including:
  • Common tasks
  • Keyboard shortcuts
  • URL formats
  • Score interpretation
  • Troubleshooting quick fixes
  • API examples
  • Best practices

Quick lookup: Quick Reference →

⚙️ Technical Guides

Advanced configuration and deployment.

• Performance Configuration - Optimization guide
• Security Best Practices - Security hardening
• Multi-Instance Deployment - Scaling guide
• Rate Limiting - API rate limits
• Feature Flags - Feature management
• Health Checks - Monitoring
• Analytics - Analytics setup
• Error Handling - Error management

🔐 Setup Guides

Service-specific configuration.

• OAuth Setup - GitHub authentication
• Redis Setup - Caching configuration
• Stripe Setup - Payment processing
• Email Service - Email configuration

🎯 Common Use Cases

For Developers

Evaluating Libraries:

1. Read Repository Analysis
2. Learn about the 5 metrics
3. Use Advanced Search to find options
4. Compare alternatives
5. Make informed decisions

Building Tech Stack:

1. Analyze your current tools
2. Use Similar Repositories to find alternatives
3. Batch analyze all options
4. Compare and choose

For Teams

Competitive Analysis:

1. Create a Collection for competitors
2. Batch analyze all competitors
3. Use Compare feature
4. Track with Analytics Dashboard
5. Export reports

Dependency Audits:

1. List all dependencies
2. Batch analyze them
3. Check maintenance status
4. Identify risks
5. Plan updates

For Organizations

API Integration:

1. Read API Documentation
2. Get API key (Pro/Enterprise)
3. Integrate with CI/CD
4. Automate analysis
5. Monitor with webhooks (Enterprise)

Team Collaboration:

1. Upgrade to Enterprise
2. Set up team workspace
3. Share collections
4. Assign roles
5. Track team activity

🛠️ Self-Hosting

Quick Setup

# Clone repository
git clone <repo-url>
cd reporadar

# Install dependencies
npm install

# Configure environment
cp .env.example .env
# Edit .env with your keys

# Setup database
npm run db:push

# Start development server
npm run dev

Full guide: Installation →

Requirements

• Node.js 18+
• PostgreSQL database
• Google Gemini API key
• Optional: Redis for caching
• Optional: Stripe for payments

Production Deployment

# Build for production
npm run build

# Start production server
npm run start

# Or use Docker
npm run deploy:docker

Deployment guide: Multi-Instance Deployment →

🤖 AI Assistant

What It Knows

The AI Assistant has comprehensive knowledge about:

• All RepoRadar features and how to use them
• The 5 analysis metrics and scoring
• Navigation and UI
• Subscription tiers and billing
• Troubleshooting common issues
• API integration
• Self-hosting setup
• Best practices

Learn more: AI Assistant Knowledge Base →

How to Use It

1. Click the AI icon in the bottom-right corner
2. Ask your question in natural language
3. Get instant, context-aware answers
4. Follow up with more questions

Available 24/7 on every page!

📊 Feature Comparison

Feature	Free	Pro	Enterprise
Analyses/month	10	Unlimited	Unlimited
Batch analysis	3 repos	Unlimited	Unlimited
Advanced search	Basic	All filters	All filters
Collections	❌	✅	✅
Analytics	❌	✅	✅
API access	❌	✅	✅
Webhooks	❌	❌	✅
Team features	❌	❌	✅
Support	Community	Priority	Dedicated
Price	Free	$9.99/mo	Custom

Full comparison: Features →

🔗 Quick Links

Essential

• Getting Started
• Quick Reference
• FAQ
• Troubleshooting

Features

• Repository Analysis
• Batch Analysis
• Similar Repositories
• All Features

Technical

• API Documentation
• Performance Configuration
• Security Best Practices
• Multi-Instance Deployment

Setup

• Installation
• OAuth Setup
• Redis Setup
• Stripe Setup

💬 Getting Help

Instant Help

AI Assistant (Recommended)

• Click icon in bottom-right corner
• Available 24/7
• Context-aware responses
• Instant answers

Documentation

Search the docs:

• Use browser search (Ctrl/Cmd + F)
• Check the Quick Reference
• Browse FAQ
• Review Troubleshooting

Community Support

• GitHub Issues: Bug reports and feature requests
• Discord Server: Community discussions
• Community Forum: Q&A and help

Direct Support

Email Support:

• support@reporadar.com
• Response times:
  • Free: 24-48 hours
  • Pro: 4-8 hours
  • Enterprise: 1-2 hours

Sales Inquiries:

• sales@reporadar.com (Enterprise)
• partnerships@reporadar.com (Partnerships)

🎓 Learning Path

Beginner

1. Read Getting Started
2. Follow Quick Start
3. Run your first analysis
4. Explore Features Overview
5. Try Batch Analysis

Intermediate

1. Master Advanced Search
2. Use Similar Repositories
3. Create Collections (Pro)
4. Explore Analytics Dashboard (Pro)
5. Learn Best Practices

Advanced

1. Read API Documentation
2. Integrate with CI/CD
3. Set up Self-Hosting
4. Configure Performance
5. Implement Security Best Practices

📝 Contributing

Documentation

Help improve the docs:

• Fix typos and errors
• Add examples
• Clarify explanations
• Suggest new guides

Code

Contribute to RepoRadar:

• Fork the repository
• Create feature branches
• Submit pull requests
• Report bugs

See CONTRIBUTING.md for guidelines.

📄 License

RepoRadar is open source. See LICENSE file for details.

🔄 Updates

Documentation Version: 2.0
Last Updated: January 2025
Covers: All features through Phase 3 implementation

Check back regularly for updates!

🚀 Ready to Start?

Choose your path:

• New User? → Getting Started
• Quick Start? → Quick Start Guide
• Self-Hosting? → Installation Guide
• Using API? → API Documentation
• Have Questions? → FAQ or AI Assistant (bottom-right)

---

Need help? The AI Assistant is always available in the bottom-right corner of every page!