https://github.com/wei/socialify
💞 Socialify your project. 🌐 Share with the world!
https://github.com/wei/socialify
badges github hacktoberfest sharing social social-image
Last synced: about 14 hours ago
JSON representation
💞 Socialify your project. 🌐 Share with the world!
- Host: GitHub
- URL: https://github.com/wei/socialify
- Owner: wei
- License: mit
- Created: 2020-09-23T00:08:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T06:13:06.000Z (9 months ago)
- Last Synced: 2025-04-11T21:46:10.779Z (9 months ago)
- Topics: badges, github, hacktoberfest, sharing, social, social-image
- Language: TypeScript
- Homepage: http://socialify.git.ci
- Size: 8.96 MB
- Stars: 2,024
- Watchers: 8
- Forks: 117
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - wei/socialify - 💞 Socialify your project. 🌐 Share with the world! (TypeScript)
- awesome-github-profile - socialify
- awesome - wei/socialify - 💞 Socialify your project. 🌐 Share with the world! (TypeScript)
README
[![GitHub Socialify][socialify-image]][socialify-edit-link]
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 [](https://github.com/search?o=desc&q=%22socialify.git.ci%22&s=indexed&type=Code) 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](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/customizing-your-repositorys-social-media-preview)** and other sites that require image upload.
### CLI
You can use the CLI tool [mheap/github-social-image](https://github.com/mheap/github-social-image) to upload social images to all your repos at once.
## Examples
## Self-Hosting
### Docker
```bash
# 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](./.env.example) for required environment variables.
## Contributing
We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) to get started.
By participating, you agree to our [Code of Conduct](./CODE_OF_CONDUCT.md).
## Authors
- [@CryogenicPlanet](https://github.com/CryogenicPlanet)
- [@wei](https://github.com/wei)
_Part of [@MLH-Fellowship](https://github.com/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
- [MIT](https://wei.mit-license.org)
## Hosting
### SLA
Socialify is under active development. Design and project domain are subject to change without notice.
Please subscribe to [#47](https://github.com/wei/socialify/issues/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.
[socialify-image]: https://socialify.git.ci/wei/socialify/image?description=1&font=Raleway&issues=1&language=1&pattern=Charlie%20Brown&pulls=1&stargazers=1&theme=Light
[socialify-edit-link]: https://socialify.git.ci/wei/socialify?description=1&font=Raleway&issues=1&language=1&pattern=Charlie%20Brown&pulls=1&stargazers=1&theme=Light
