Skip to content

professor-lee/StoneBadge

Repository files navigation

Stone Badge logo

Stone Badge - GitHub Stone Badge Generator

简体中文    |    >English<

Project Overview

Stone Badge is a Node.js service that generates a 3D stone badge SVG from the latest commit SHA of a GitHub repository. It reads the repository's newest commit, turns the short SHA into unique colors, gradients, and glow effects, and returns an SVG badge that can be embedded directly into a README.

Usage Address

Features

  • Generate a stone badge from any GitHub repository URL
  • Auto-color the SVG from the latest commit SHA, so every repository gets a distinct result
  • Preview the badge in the browser and copy Markdown, HTML, or a direct link with one click
  • Support POST /api/generate to parse repository URLs and return badge metadata
  • Support GET /api/stone/:owner/:repo to return the SVG badge directly
  • Support automatic template generation and manual template upload through POST /api/template
  • Keep the frontend static, with low deployment and maintenance overhead

Tech Stack

  • Node.js 18+
  • Express
  • Three.js
  • JSDOM
  • Native fetch
  • HTML, CSS, JavaScript

Usage

  1. Open https://stone.professorlee.work
  2. Enter a GitHub repository URL, such as https://github.com/professor-lee/StoneBadge
  3. Click Generate Badge
  4. Copy the Markdown, HTML, or direct link into a README, document, or website

Example Markdown:

![Stone Badge](https://stone.professorlee.work/api/stone/professor-lee/StoneBadge)

Deployment Instructions

See DeploymentInstructions.md for the full deployment guide.

Demo Examples

StoneBadge

https://github.com/professor-lee/StoneBadge

Stone Badge

CNMPlayer

https://github.com/professor-lee/CNMPlayer

Stone Badge

TMPlayer

https://github.com/professor-lee/TMPlayer

Stone Badge

Next.js

https://github.com/vercel/next.js

Stone Badge

Node.js

https://github.com/nodejs/node

Stone Badge

VS Code

https://github.com/microsoft/vscode

Stone Badge

Vue.js Core

https://github.com/vuejs/core

Stone Badge

TensorFlow

https://github.com/tensorflow/tensorflow

Stone Badge

Star History

Star History Chart

About

Add a Rotating Stone in your README file.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors