Shields.io is a service and NPM library that generates concise SVG and raster status badges for README files and web pages.
wei/socialify
Generates shareable social preview images for GitHub repositories, with live stats, logos, fonts and background patterns.
- Stars
- 2,222
- Forks
- 122
- Open issues
- 13
- Last commit
- 11 days ago
What is it?
Socialify creates a project image for GitHub repositories that can be used in READMEs, social posts, or as a repository social preview. Users pick a repository and toggle elements such as description, owner, language, stars, forks, issues and pull requests, then adjust the look with a custom logo, font, theme and background pattern.
There are two ways to use the output. The social image endpoint returns a live image whose counts update automatically, which suits README files and img tags. Downloaded images in PNG, JPEG or WebP format can be uploaded wherever an image file is required, such as GitHub's social preview setting. A community CLI, github-social-image, can push images to many repositories at once.
Socialify is a TypeScript project under the MIT license that can also be self-hosted with Docker.
Key features
- 01Generates project images for any GitHub repository
- 02Shows live stats such as stars, forks, issues and pull requests
- 03Supports a custom logo, multiple fonts and background patterns
- 04Offers light and dark themes
- 05Exports images as PNG, JPEG or WebP
- 06Can be self-hosted with Docker
Use cases
- Adding a live-updating banner to a project README
- Setting a custom GitHub repository social preview image
- Creating a branded image for sharing an open-source project
- Batch-generating social images for many repositories
Quick start
- 1
Copy the environment variables listed in .env.example into a .env file
- 2
Start the app with docker-compose
docker-compose up -d - 3
Or build and run the Docker image directly
docker build -t socialify . && docker run -p 3000:3000 --env-file .env socialify
Things to know
- Socialify is under active development, and its design and project domain may change without notice.
In collections
Topics
FAQ
- What is socialify?
- Generates shareable social preview images for GitHub repositories, with live stats, logos, fonts and background patterns. Socialify creates a project image for GitHub repositories that can be used in READMEs, social posts, or as a repository social preview. Users pick a repository and toggle elements such as description, owner, language, stars, forks, issues and pull requests, then adjust the look with a custom logo, font, theme and background pattern.
- Is socialify free to use? What license does it have?
- socialify is open source under the MIT license. Check the license terms before using it in commercial products.
- Is socialify still maintained?
- Actively maintained. The last commit to socialify was on Oct 28, 2026.
- What can I use socialify for?
- Adding a live-updating banner to a project README Setting a custom GitHub repository social preview image Creating a branded image for sharing an open-source project Batch-generating social images for many repositories
- How do I install socialify?
- Copy the environment variables listed in .env.example into a .env file Start the app with docker-compose: docker-compose up -d Or build and run the Docker image directly: docker build -t socialify . && docker run -p 3000:3000 --env-file .env socialify
- Where can I get socialify?
- The source code and installation instructions are on GitHub: https://github.com/wei/socialify
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
A Markdown syntax reference and test file showing how GitHub Flavored Markdown (GFM) renders in READMEs, issues and wikis.
Turns a GitHub contribution graph into an animated Galaga-style space shooter GIF or WebP that you can embed in your profile.
A self-hostable web app where friends watch YouTube, Vimeo and other videos together in sync, without needing accounts.
The all-in-one GitHub SDK for Browsers, Node.js, and Deno, combining REST, GraphQL, GitHub App, webhook, and OAuth clients in one package.
Go client library for accessing the GitHub v3 REST API, with typed services for repos, orgs, issues, and more.