Giter Club home page Giter Club logo

socialify's Introduction

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 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

Development

  • Create a GitHub token from Settings > Developer settings > Personal access tokens, you'll need it in when setting up environemnt variables.

  • You'll need the repo scope

  • Run the following commands to set up the Development server:

    # Clone
    git clone https://github.com/wei/socialify.git && cd $_
    
    # Set environment variables in .env
    cp .env.example .env
    
    yarn install
    yarn build
    yarn dev

Authors

Part of @MLH-Fellowship Pod 1.0.6

License

Hosting

Powered by Vercel

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.

socialify's People

Contributors

akshgpt7 avatar cryogenicplanet avatar dependabot[bot] avatar github-actions[bot] avatar sboulema avatar t-moennich avatar thelastzombie avatar wei avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

socialify's Issues

Next.js 12 Upgrade

I think there are a lot of things in next-12 that could completely reshape this project and make it way faster

We could definitely look into Server Components with nextjs and serving from the edge instead of cloud functions

All that said we definitely need to wait on for relay support
vercel/next.js#30174

The real question tho is about time and availability but definitely something we can look into doing slowly over a period of time

https://nextjs.org/blog/next-12

Back and forward buttons should change config

Currently you can click around the config. Back and forward buttons will add/remove items from the query string but the config on the page is not updating accordingly. We should make it update and match the url qs.

"Issues" badge should only include "open" issues

Great tool!

Currently, when selecting the "issues" checkbox, it includes all issues, including ones that have been closed. It seems it would be much better to include only the "open" issues. Does the GitHub API allow that instead of all issues?

[BUG] Not updating issues open

I created a test issue to test if socialify would update the issue number on the banner, it didn't update, it only updated when I took a link, got rid of something, then it updated and I waited for 10-12 mins, don't think it was supposed to be like that, I thought it auto updates?

image
image

README Updates

  • Add a note in the README that says the design is subject to change without notice.
  • Always choose the download option if that's going to be a problem.
  • Add .env instructions

Add Google Analytics

We'll start with just the basic script for now. Consider adding events in the future.

Tracking Policy

Hey there!
First of all, great app!:fire:

I was just wondering that since the working and use of this would be similar to shields.io, it would be nice to add a "No Tracking" disclaimer.

Other options would be:

  • Add a tracking feature and pass on that feature to the end-user.
  • Keep tracking optional.

Stars and Pulls don't update

Hello,

I'm using the generated markdown at https://github.com/pinpox/nixos but the counters don't seem to update.
For example the repository has one star at this time, but the image shows 2:
image

If I create a new banner for the same repo the values are correct, but it doesn't seem to be tracking any changes otherwise

Add Repo input to config component

This way users can switch between repos without the need to go back to home page.

This will also allow the config to be persisted when switching between repos.

Import Google Font css

google-fonts-plugin was removed with our dependency upgrade 434727f.

Let's look into a better way to import google font into the svg image.

URL Path handling

  • History Handling
  • Ability to go back
  • Github Socialify big back button
  • Configuration in url
  • Query string overwrite configuration

Service Updates

This pinned issue will contain breaking changes for the project including major design changes or domain changes. We will provide early notice should a domain change be necessary.

Please subscribe to this issue if you'd like to receive updates.

Use Devicons SVG instead of Font

Currently we are embedding our custom devicon font containing all icons into every image we output. Using SVGs should make it more performant.

Next.js 13 Upgrade

Next.js 12 upgrade was completed #111. It's time to keep up with the trend and go to Next.js 13 ๐Ÿ˜„.

Initial card design

Implement initial social card design

Card Elements

  • name
  • logo
  • owner
  • description
  • font
  • language
  • stargazers
  • forks
  • issues
  • pulls
  • theme
  • pattern

FR: Private repo support

Wow ... those images looks so beautiful.

I have a few public repos but mostly work with private repos. The website isn't able to see them because they're ... private.

I'd like to keep a consistent readme style across all project. Is there currently a process for private repos?

Badges not updating

Badges are not updating as they should. I don't know if it is a cache problem on my device or something else. Does enabling ad blocker prevent badges from updating?

btw great app ๐Ÿ’“

Add option to display Closed Issues/PRs

It would be great if there was an an option to be able to display how many issue and PRs have been closed for a project. It would be a nice indicator to see how many features/work has been done on a project.

The opposite to #75.

Custom shields

Hi, first of all, great project, really love it and I'm already using it in my repos.

It would be great to be able to use custom shields in the project image. Currently we can only turn on/off some specific shields related to the repo (stars, issues, forks), but it would be great to be able to add custom ones. For instance, these are the shields I have in my project's README.rst file:

image

It would be wonderful if there was a way of adding these to the project image itself.

Add Kotlin logo

Add Kotlin to the list of supported programming languages.

URL Shortener

The generated image url always contain long query strings. Let's create a url shortener so it's not so long~

Make project name an option

Create a checkbox for project/repo name similar to owner checkbox. That way, if project logo is an image that contains project name (like facebook logo for example), I want to be able to hide the text below it.

Improve image loading speed

  • Create a route/or api that takes in the same :owner/:name?:qs and returns prerendered card in html (using ssr)
    Similar to how og-image is doing it but we'll render card component instead
  • Update screenshotter url to use the new route
  • Move third party dependencies to inside the project to save calls (Google Fonts, DevIcons, etc)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.