https://github.com/david-fernando/github-card-api

Unofficial GitHub API that return your social preview url
https://github.com/david-fernando/github-card-api

Last synced: about 4 hours ago
JSON representation

Unofficial GitHub API that return your social preview url

• Host: GitHub
• URL: https://github.com/david-fernando/github-card-api
• Owner: david-fernando
• License: mit
• Created: 2021-07-18T21:48:02.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-23T19:33:08.000Z (over 2 years ago)
• Last Synced: 2023-03-03T20:09:14.131Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 212 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
GitHub Card API




[![Status](https://img.shields.io/badge/status-active-success.svg)]() [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)



---

 Unofficial GItHub API that return your social preview url

    
 



## 📝 Table of Contents

- [How to use](#how_to_use)

- [How to contribute](#how_to_contribute)

- [Built Using](#built_using)

- [Authors](#authors)

## 🏁 How to use 

Make a get request to the url below with your Medium user

```bash

GET https://githubcardapi.herokuapp.com/?githubuser={{yourgithubusername}}&repository={{yourrepository}}

```

Example

```bash

https://githubcardapi.herokuapp.com/?githubuser=david-fernando&repository=medium-posts-api

```

The request for the above url will bring the following result

```bash

 imageUrl: "https://repository-images.githubusercontent.com/328493464/dba6e680-569b-11eb-8a15-47228be0ccfe"

```

### How to contribute

 Fork this repository, make clone for your machine.

 Install the dependencies with one of the commands below:

 ```bash

 yarn install

 

 # or

 npm install

 ```

Then, run the development server.

```bash

yarn dev

# or

npm dev

```

Then, let's get coding.

When everything is ready, do a pull request to the branch development.

## ⛏️ Built Using

- [Express](https://expressjs.com/) - Server Framework

- [NodeJs](https://nodejs.org/en/) - Server Environment

## ✍️ Author

- [@david-fernando](https://github.com/david-fernando) - Idea & Initial work