Introduction

GitHub Flex is a lightweight service that generates customizable SVG badges for your GitHub profile. Inspired by github-readme-stats, this project was built from scratch to provide more flexibility and customization options while maintaining full control over the deployment and API usage.

Motivation

While github-readme-stats is an excellent project, I wanted to make some tweaks for my personal use. Since the original project is currently paused on Vercel (thus requiring self-hosting), I had two options: fork and deploy it myself, or start fresh. I chose the latter to keep things minimal.

Key Features

• Customizable SVG badges with various styles and color schemes.
• GitHub stats visualization including repository stats, contribution metrics, and more.
• Serverless deployment on Vercel for easy maintenance.
• Minimal dependencies to keep the codebase lightweight and maintainable.
• Fast response times optimized for SVG generation and delivery.
• No framework overhead - built with vanilla Node.js for maximum performance.

Challenges and Solutions

• Serverless Deployment: The main challenge was getting the project to work seamlessly in a serverless environment.
• API Rate Limiting: Working with the GitHub API meant dealing with rate limits. Solution: cache responses and use a personal access token to increase the limit.
• SVG Generation: Creating dynamic, visually appealing SVG badges programmatically required understanding SVG syntax deeply and ensuring cross-browser compatibility. I built a simple but effective SVG templating system that allows for easy customization.

Outcome

The project successfully delivers customizable GitHub profile badges with minimal latency and overhead. By keeping the architecture simple and avoiding unnecessary frameworks, the service is easy to maintain and modify. The serverless deployment on Vercel ensures it runs smoothly without the need for infra management. The code is naturally open-sourced on GitHub, allowing others to use it as a starting point for their own badge generation needs or to contribute improvements.