Skip to content

Latest commit

 

History

History
117 lines (72 loc) · 7.44 KB

File metadata and controls

117 lines (72 loc) · 7.44 KB

GitHub Socialify

Want your project to stand out? Socialify helps you showcase your project to the world by generating a beautiful project image like the one above!

It includes a ton of options including custom logo, description, badges, and many fonts and background patterns to choose from.

Join thousands of repositories today!

Usage

Project site: https://socialify.git.ci

Social Image as a Service

Click on the image to use the link anywhere, the image will be programmatically generated with live data. This means the badges will automatically update.

Recommended for README files or img tags.

Image Download

You can download the image as a .png, .jpeg or .webp and use it anywhere in the world!

Recommended for GitHub repository social preview image and other sites that require image upload.

CLI

You can use the CLI tool mheap/github-social-image to upload social images to all your repos at once.

Examples

Session Bot Example Class Photo Example Modfy Example Pull Example Traefik Example React Example

Self-Hosting

Docker

# Using docker-compose
docker-compose up -d

# Or using docker directly
docker build -t socialify .
docker run -p 3000:3000 --env-file .env socialify

See .env.example for required environment variables.

Contributing

We welcome contributions! Please see our Contributing Guide to get started.

By participating, you agree to our Code of Conduct.

Authors

Part of @MLH-Fellowship Pod 1.0.6

Community

These are the heroes who continue to make Socialify the best social preview generator for the community.

License

Hosting

Deploys by Netlify

SLA

Socialify is under active development. Design and project domain are subject to change without notice.

Please subscribe to #47 if you would like to receive service updates.

Consider downloading the images or self-hosting should this be a problem.

Privacy

Socialify does not collect any personal or identifiable information, we do not use cookies, do not collect emails or anything.

Socialify uses Google Analytics on web pages to understand overall usage. Generated image links do not have any tracking.