Home/Docs/Getting Started

Getting Started with RepoPulse

Learn how to analyze repositories, add badges to your README, and customize visualizations

Quick Start (3 minutes)

Analyze a Repository

Visit any repository analysis page to see health scores, insights, and metrics.

Example URL:https://repopulse-one.vercel.app/repo/vercel/next.js

What you'll see: Health score (0-100), actionable insights, detailed metrics, trends, and preview of cards/badges.

Add a Badge to Your README

Copy badge URLs from the repository page or badges gallery to showcase your project health.

Example Markdown:![Health](https://repopulse-one.vercel.app/api/badge/health?repo=yourusername/yourrepo)

What it does: Displays a dynamic badge showing your repository's health score that updates automatically.

Customize with Themes

Choose from 100+ card themes and 25+ badge styles to match your project's branding.

Example with Theme:https://repopulse-one.vercel.app/api/card/repo?repo=yourusername/yourrepo&theme=dracula

When to use: When you want your repository visualizations to match your project's aesthetic or personal brand.

Step-by-Step Guide

Step 1: Finding Repositories to Analyze

Using the Search Bar

The search bar on the home page accepts any public GitHub repository in owner/name format.

Examples to try:

vercel/next.js
facebook/react
microsoft/vscode
torvalds/linux

Using Direct URLs

You can also navigate directly to any repository analysis by constructing the URL.

URL Pattern:/repo/owner/repository-name

Replace owner and repository-name with actual GitHub values.

Step 2: Understanding What You See

Health Score (0-100)

Overall repository health based on activity, maintenance, community, and growth factors.

When to use: Quick assessment of repository quality and sustainability.

Insights

Actionable recommendations with confidence scores explaining what the repository does well and where it could improve.

When to use: When you want specific guidance on repository health or improvement opportunities.

Metrics & Trends

Detailed statistics including star growth, commit patterns, issue resolution times, and contributor diversity.

When to use: When you need comprehensive data for research or detailed analysis.

Step 3: Adding RepoPulse to Your Project

README Badges

Add dynamic badges to your README.md to showcase repository health.

Markdown to add:

<!-- Health Badge -->
![Health](https://repopulse-one.vercel.app/api/badge/health?repo=yourusername/yourrepo)

<!-- Stars Badge -->
![Stars](https://repopulse-one.vercel.app/api/badge/stars?repo=yourusername/yourrepo)

<!-- Activity Badge -->
![Activity](https://repopulse-one.vercel.app/api/badge/activity?repo=yourusername/yourrepo)

What it does: Displays live-updating badges that show current repository metrics.When to use: In README files, documentation, or anywhere you want to showcase project health.

Repository Cards

Embed beautiful SVG cards showing comprehensive repository information.

Markdown to add:

<!-- Repository Card -->
![RepoPulse](https://repopulse-one.vercel.app/api/card/repo?repo=yourusername/yourrepo)

<!-- Language Card -->
![Languages](https://repopulse-one.vercel.app/api/card/languages?repo=yourusername/yourrepo)

What it does: Shows detailed repository stats, language breakdown, and health metrics in a beautiful card format.When to use: When you want to provide comprehensive project information in visual form.

Advanced Usage

Customizing Analysis Windows

Control how far back RepoPulse analyzes repository data.

Example:/repo/vercel/next.js?window=90

Analyzes the last 90 days of activity instead of the default 365 days.

Filtering Insights

Focus on specific types of insights.

Example:/repo/vercel/next.js?insights=activity,growth

Only show insights related to activity and growth patterns.

API Integration

Use RepoPulse data programmatically.

Example:curl https://repopulse-one.vercel.app/api/repo/vercel/next.js

Get JSON data for repository analysis that you can process in your applications.

Troubleshooting

Repository Not Found

Make sure the repository exists and is public. Check the spelling of owner/repository-name.

Slow Loading

Large repositories may take longer to analyze. Data is cached for 1 hour to improve performance.

Rate Limits

GitHub API has rate limits. For higher limits, the site uses authenticated requests.

Next Steps

Now that you know the basics, explore more advanced features: