Github Embed Generator

Go API project for generating svg for github embed
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Github Stats Card
   • Top Languages Card
   • Project Card
   • Skills Card
   • Organization Activity Card
   • Activity Card for repositories
   • Streak Card
   • Icon Card
   • Themes
   • Customization
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Go API project for generating svg's, which can be used in github profiles, repository readmes and much more!

Project is currently not hosted due to my poorness

(back to top)

Built With

This project is written in Go!

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To run this project you'll need to have go installed on your computer. You can download it here

Check go version

go version

Installation

1. Clone the repo

   git clone https://github.com/ArvidWedtstein/Github-Embed-Generator.git

2. Create a .env file in the root directory and add your environment variables.

3. Run

   go run .

(back to top)

Deploying

I had this project deployed on heroku, since netlify doesn't support deploying for GO.

Usage

This project can be used for adding useful information to your github profile, repository readme and much more!

A generator can to generate the url for you can be found here (current not working)

Here are some useful notes on how to use this project!

GitHub Stats Card

Change the ?user= to your own Github username.

[![Arvid's Github Stats](https://arvidgithubembed.herokuapp.com/stats?user=arvidwedtstein)]

Themes

Yes. Da themes have arrived. You can now customize your card without having these long urls

To use a theme add the parameter &theme=THEME_NAME to the url

[![Arvid's Github Stats](https://arvidgithubembed.herokuapp.com/stats?user=arvidwedtstein&theme=retro)]

Current themes are: light, dark, rgb, lartrax, retro, vue-dark, ig9te, github, red, toringe

Customization

This API allows you to hide individual stats with the query parameter ?hide=. Multiple stats to hide have to be comma-seperated.

Options: contributions,milestones,packages,forks,releases,watchers,stars,disk,pull,issues,repocontributions,orgcontributions

[![Arvid's Github Stats](https://arvidgithubembed.herokuapp.com/stats?user=arvidwedtstein&hide=contributions,disk)]

Some Customization Options:

All hex colors without '#' please

• titlecolor - Card's title color (hex color)
• textcolor - Card's text color (hex color)
• bordercolor - Card's border color (hex color).
• backgroundcolor - Card's background color (hex color)
• boxcolor - Card's box color (hex color)
• title - Card's custom title (string)

Repository Commitactivity Card Exclusive Options:

• hide_week - Hides the week numbers on the card (boolean)
• repo - The name of your repository (github repository name)

/commitactivity?:user&:repo

Roadmap

• Refactor whole project
• Implement a better system for embed themes
• Fix docs

See the open issues for a full list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! <3

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

No contact :)

(back to top)

Acknowledgments