GitHub Profile Views

Track your GitHub profile visitors with SVG badges

Example of how your badge will look:

What does this do?

This project creates a simple API that tracks how many people visit your GitHub profile. When someone views your profile, it increments a counter and shows a nice SVG badge with the number of views.

How to Deploy

Step 1: Setup Upstash Redis (Free Database)

Go to https://console.upstash.com/
Create a free account
Click "Create Database" and choose Redis
Copy your UPSTASH_REDIS_REST_URL
Copy your UPSTASH_REDIS_REST_TOKEN

Important: Keep these credentials safe - you'll need them in the next step.

Step 2: Get the Code

Fork or download the repository from GitHub
Create a file called .env.local in the project folder
Add your Upstash credentials:

UPSTASH_REDIS_REST_URL=your_redis_rest_url_here
UPSTASH_REDIS_REST_TOKEN=your_redis_rest_token_here

Step 3: Deploy to Vercel (Recommended)

Go to https://vercel.com
Sign up with your GitHub account
Click "New Project" and import your repository
Add your environment variables in the Vercel dashboard:
- UPSTASH_REDIS_REST_URL
- UPSTASH_REDIS_REST_TOKEN
Click "Deploy"

Step 4: Add Badge to Your GitHub Profile

Once deployed, add this to your GitHub profile README:

![Profile Views](https://domain_name/api/your-github-username)

Replace:

your-app-name with your Vercel app name
your-github-username with your actual GitHub username

That's it! Your profile view counter is now working. Every time someone visits your GitHub profile, the counter will increase.

Connect your GitHub repository to Railway
Add environment variables
Deploy

Testing Your Setup

After deployment, test your API by visiting:

https://your_domain/api/your-username

You should see an SVG badge with a view count that increases each time you refresh the page.

Free Tier Limits

Upstash: 10,000 requests per day, 256 MB storage
Vercel: 100 GB bandwidth per month
Perfect for personal use!

Troubleshooting

Badge not showing?

Check that your environment variables are set correctly
Make sure your GitHub username is correct in the URL
Verify your Upstash database is active

Counter not incrementing?

Check your Upstash Redis connection
Look at the deployment logs for errors
Try refreshing the API URL directly

Need Help?

If you run into issues:

Check the GitHub repository for documentation
Look at the issues section for common problems
Create a new issue if you need help

Crafted by Shyam Mahanta