https://github.com/po3rin/github_link_creator

GitHub Link Card Creator lets you generate GitHub images has links to repositories.
https://github.com/po3rin/github_link_creator

aws github go image image-processing

Last synced: about 1 month ago
JSON representation

GitHub Link Card Creator lets you generate GitHub images has links to repositories.

• Host: GitHub
• URL: https://github.com/po3rin/github_link_creator
• Owner: po3rin
• License: apache-2.0
• Created: 2019-01-27T16:15:25.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-05-05T02:28:50.000Z (over 1 year ago)
• Last Synced: 2024-08-02T17:32:33.456Z (4 months ago)
• Topics: aws, github, go, image, image-processing
• Language: Go
• Size: 3.73 MB
• Stars: 203
• Watchers: 6
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - po3rin/github_link_creator - GitHub Link Card Creator lets you generate GitHub images has links to repositories. (Go)

README

        


  

  
GitHub Link Card Creater

  
GitHub Link Card Creator lets you generate GitHub images has links to repositories.


---

 [![CircleCI](https://circleci.com/gh/po3rin/github_link_creator.svg?style=shield)](https://circleci.com/gh/po3rin/github_link_creator)  [![GolangCI](https://golangci.com/badges/github.com/po3rin/github_link_creator.svg)](https://golangci.com)

## :mag_right: Overview

GitHub Link Card Creator lets you generate GitHub images has links to your repositories. This card is useful to guide to your repository in blogs etc.



## :pencil: Official WEB Client

here !!

https://ghlinkcard.com

## Instalation

using as CLI, you should install

```go

$ go get "github.com/po3rin/github_link_creator/cmd/repoimg"

```

You can also install from here

https://github.com/po3rin/github_link_creator/releases

## Usage

### CLI Mode

this lets you generate repository card in local.

```bash

repoimg -n po3rin/gotree

```

### Server Mode

set environment valiable ```S3_BUCKET_NAME```. this is target bucket to store image.

```bash

$ go build

$ ./github_link_creator

$ curl localhost:8080/v1/images//

```

When raising the upper limit of API call of GitHub, You should set environment valiable ```GITHUB_CLIRNT_ID``` & ```GITHUB_SECRET```.

> GitHub REST API v3 Documents

> https://developer.github.com/v3/#rate-limiting

## WEB Client Repository



## Contributing

You're most welcomed!

Welcome pull request and issues.