david-fernando / github-card-api

Unofficial GitHub API that return your social preview url

GitHub Card API

---

Unofficial GItHub API that return your social preview url

📝 Table of Contents

• How to use
• How to contribute
• Built Using
• Authors

🏁 How to use

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

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

Example

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

The request for the above url will bring the following result

 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:

yarn install

# or

npm install

Then, run the development server.

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 - Server Framework
• NodeJs - Server Environment

✍️ Author

• @david-fernando - Idea & Initial work