Github Pinned

github-pinned is a small microservice with which you can fetch the six repositories pinned to your repositories. It is written in Typescript with the Deno framework and dockerized for easier usage.

📦 Installation

A Docker image is available on the public docker registry which you can use as you like. The only thing you have to provide to the container is the config.yml file you can also find inside this repo:

username: <Github user to fetch from>
token: <Your Github token>

If you need to know how to create a token please consult this Guide

Docker pull

docker pull schufeli/github-pinned

Docker run

docker run -p "<Port>:8080" --name github-pinned -v ./config.yml:/app/config.yml github-pinned

Docker-Compose

Please have a look at the provided docker-compose.yml file.

🚀 How to use

Request a Post

To fetch a Post from the Service you will need to send an HTTP GET Request to your hosted Github-pinned instance (I will use localhost in the following examples!).

https://localhost<:Port>/ 

Response

If your request was successful you will get a JSON object which is similar to the following example with the description of each element.

[
    {
        "name": "<Repository name>",
        "description": "<Respository description>",
        "url": "<URL to repository>",
        "forkCount": "<Count of forks>",
        "stargazerCount": "<Count of stars",
        "primaryLanguage": {
            "name": "<Language name>",
            "color": "<Language color>"
        }
    }
]