Decorate your GitHub profile with awesome trophies!

API Usage

Basic Usage:

http://localhost:3000/trophy?username=YOUR_GITHUB_USERNAME

Examples:

Basic:

![GitHub Trophy](http://localhost:3000/trophy?username=torvalds)

With Theme:

![GitHub Trophy](http://localhost:3000/trophy?username=torvalds&theme=onedark&column=4)

Filter by Rank:

![GitHub Trophy](http://localhost:3000/trophy?username=torvalds&rank=S,A)

Exclude Trophies:

![GitHub Trophy](http://localhost:3000/trophy?username=torvalds&title=-Gists,-Experience)

Transparent Background:

![GitHub Trophy](http://localhost:3000/trophy?username=torvalds&no_bg=true&no_frame=true)

How to Add to Your GitHub Profile?

1. Open your GitHub profile README.md file
2. Copy the markdown code from the trophy generator
3. Paste it into your README.md
4. Commit and push!

Trophies

Rank System:

The rank system evaluates your GitHub profile across 7 different categories. Each trophy has its own ranking thresholds based on the metric.

Rank Badges:

Rank	Badge	Title	Tier	Achievement
SSS		Legendary	Mythic	Top 0.1% - Living legend
SS		Grandmaster	Elite	Top 1% - Elite status
AAA		Champion Elite	Master	Top 3% - Masters level
AA		Champion	Expert	Top 5% - Expert level
S		Star Performer	Advanced	Top 10% - Well established
A		Veteran	Intermediate	Top 20% - Experienced
B		Challenger	Intermediate	Top 45% - Rising star
C		Contender	Beginner	Top 72% - Active member
D		Rookie	Rookie	Just getting started

Themes

• Flat: Clean and simple design
• Dark: For dark mode lovers
• OneDark: Popular code editor theme
• Radical: Bold and colorful
• Gruvbox: Retro developer theme
• Dracula: Dark vampire theme

Node.js Support 🚀

This project uses Node.js runtime with modern ES modules!

Why Node.js?

✅ Mature ecosystem with npm packages
✅ Wide community support
✅ Production-ready with excellent performance
✅ Built-in testing with node:test
✅ Native ES modules support

Docker Deployment 🐳

Using Docker:

Build image:

docker build -t github-trophy .

Run container:

docker run -p 3000:3000 --env-file .env github-trophy

Or with inline token:

docker run -p 3000:3000 -e GITHUB_TOKEN=your_token_here github-trophy

Using Docker Compose:

Start services:

docker-compose up -d

This will start the GitHub Trophy app on port 3000.

View logs:

docker-compose logs -f

Stop services:

docker-compose down

Rebuild:

docker-compose up -d --build

Environment Variables:

Create .env file with your GitHub token:

GITHUB_TOKEN=ghp_your_token_here

Or add multiple tokens (comma-separated):

GITHUB_TOKEN=token1,token2,token3

Deployment Options:

You can deploy this to:

• 🐳 Docker (local or VPS)
• Vercel
• Heroku
• Railway
• Render
• AWS ECS/EKS
• Google Cloud Run
• Azure Container Instances

After deployment, replace the URL with your production URL.

Testing

Run all tests:

npm test

Run tests in watch mode:

npm test -- --watch

Format code:

npm run format

Lint code:

npm run lint

Contributing

Contributions are welcome! Please read our Contributing Guidelines and Code of Conduct before submitting PRs.

Development Setup

1. Fork and clone the repository
2. Create a .env file from .env.example
3. Add your GitHub token (optional but recommended)
4. Run the development server:

   npm run dev

5. Make your changes and add tests
6. Run tests: npm test
7. Format code: npm run format
8. Submit a PR!

Security

For security issues, please review our Security Policy.

License

MIT License - see the LICENSE file for details.

Acknowledgments

• Built with Node.js 🚀
• Powered by GitHub GraphQL API
• Inspired by the amazing GitHub developer community

---

Made with ❤️ for GitHub developers

Star ⭐ this repo if you found it useful!