Skip to content

SamXop123/samdev-pulse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

174 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ samdev-pulse

A calm, modern GitHub profile dashboard β€” generated as a single SVG.

Drop one image into your README and get live GitHub stats, contribution activity, language breakdowns, and achievement trophies. No widgets. No clutter. It just works.


⚑ Quick Usage

Add this to your GitHub profile README (repo name = your username):

![samdev-pulse](https://samdev-pulse.vercel.app/api/profile?username=YOUR_GITHUB_USERNAME)

That’s it. Your profile now renders a live dashboard.

Live Example Preview

samdev-pulse live preview


🎨 Customization Examples

Theme

![samdev-pulse](https://samdev-pulse.vercel.app/api/profile?username=YOUR_GITHUB_USERNAME&theme=tokyonight)

Available themes: dark (default), light, dracula, nord, tokyonight, monokai, gruvbox, solarized, catppuccin, rose-pine


LeetCode Stats (Optional)

![samdev-pulse](https://samdev-pulse.vercel.app/api/profile?username=YOUR_GITHUB_USERNAME&leetcode=YOUR_LEETCODE_USERNAME)

Disable LeetCode and show repository stats instead:

![samdev-pulse](https://samdev-pulse.vercel.app/api/profile?username=YOUR_GITHUB_USERNAME&leetcode=false)

Header Alignment

![samdev-pulse](https://samdev-pulse.vercel.app/api/profile?username=YOUR_GITHUB_USERNAME&align=center)

Options: left (default), center, right


Full Example

![samdev-pulse](https://samdev-pulse.vercel.app/api/profile?username=SamXop123&theme=tokyonight&leetcode=Dot_NotSam&align=center)

Why samdev-pulse?

  • Designed as one cohesive SVG, not stitched widgets
  • Calm, readable visuals that don’t overpower your profile
  • Built for developers who care about craft, clarity, and signal over noise

✨ Features

πŸ“Š GitHub Activity

  • Total contributions (year)
  • Pull requests opened
  • Issues opened
  • Live data via GitHub REST API

πŸ”₯ Streak Statistics

  • Current streak
  • Longest streak
  • Total contribution days
  • Powered by GitHub GraphQL API

πŸ“ˆ Contribution Activity Graph

  • SVG line chart (last 30 days)
  • Auto-scaled Y-axis
  • Smooth curves with gradient fill

🍩 Top Languages

  • Donut chart (top 5 languages)
  • Percentage-based slices
  • Calculated from public repositories

πŸ’» LeetCode Integration (Optional)

  • Total problems solved
  • Easy / Medium / Hard breakdown
  • Contest rating with fallback to ranking

πŸ† Achievement Trophies

A visual trophy system highlighting GitHub milestones:

Trophy Description
πŸ’ͺ Commits Total contributions
πŸ”€ Pull Requests PRs opened
πŸ› Issues Issues opened
πŸ“¦ Repositories Public repos
⭐ Stars Total stars
πŸ‘₯ Followers GitHub followers
πŸ“Š Trophy tier requirements
  • πŸ₯‰ Bronze: Entry level (1+)
  • πŸ₯ˆ Silver: 100+ (500+ for stars)
  • πŸ₯‡ Gold: 500+ (1000+ for stars)
  • πŸ’Ž Diamond: 1000+ (5000+ for stars)

βš™οΈ Query Parameters

Parameter Type Default Description
username string SamXop123 GitHub username
theme string dark Visual theme
leetcode string / false – LeetCode username or disable
align string left Header alignment

πŸ› οΈ Local Development

Prerequisites

  • Node.js 18+
  • GitHub Personal Access Token

Setup

git clone https://github.com/SamXop123/samdev-pulse.git
cd samdev-pulse
npm install

Environment Variables

GITHUB_TOKEN=your_github_personal_access_token
DEFAULT_USERNAME=octocat
PORT=3000
NODE_ENV=development

Run

npm run dev

Visit:

http://localhost:3000/api/profile?username=octocat

πŸ” API

GET /api/profile

Returns an SVG dashboard.

  • Content-Type: image/svg+xml
  • Cache-Control: public, max-age=1800

GET /health

Health check endpoint.


πŸ“ Project Structure

src/
β”œβ”€β”€ routes/        # API routes
β”œβ”€β”€ services/      # GitHub & LeetCode APIs
β”œβ”€β”€ renderers/     # SVG layout & charts
β”œβ”€β”€ themes/        # Theme definitions
└── utils/         # Caching & helpers

πŸ”’ Usage & privacy

samdev-pulse logs basic, non-sensitive usage information (such as the github username passed to the api) for monitoring and improving the service.

no personal data, authentication details, or private information is collected.


🀝 Contributing

Contributions are welcome. Please see CONTRIBUTING.md for guidelines.

Ideas:

  • More themes
  • Codeforces / CodeChef support
  • New trophy categories
  • Animated SVG elements
  • CI & tests

πŸ“ License

MIT Β© SamXop123


⭐ Support

If this helped you, consider giving the repo a ⭐ It helps more developers discover the project.