DEV Community

Cover image for Create Your Github readme with automated news data
mridul037
mridul037

Posted on

Create Your Github readme with automated news data

GitHub added a new feature ,where you could have a README on your GitHub profile.It could be used as portfolio or just a fun project.

GitHub profile README

So what is that GitHub profile README thingy? Its a cool new feature by GitHub which allows you to have a README on your profile. Sounds cool? Surely it is. Time to get creative 😋.

How to include TeachCrunch news api data in readme

So to access the news API, you need to have an access key.
which you can get here https://newsapi.org/
So how do we get TeachCrunch news? Well, the answer is really easy. So we will do it in NodeJS. We will install some dependencies.

We installed 3 dependencies here, but express , dotenv and isomorphic-unfetch.
npm i isomorphic-unfetch

index.js
(code snipit)
Alt Text

The auto updating README

Create README.template.md with replacement tags

Alt Text

Using Github Actions for AutoUpdate

Now we have created the scripts, we need to automate it to update the README every hour. For this, we will use GitHub's actions.
Alt Text
As a bonus, I also used the Programming Quotes API to get the quote of the hour.

what you get

github link:

Hi, I'm Mridul

A passionate developer from India


Hi, I'm Mridul Shukla, a Full Stack Developer 🚀 from India, Freelancer, completed masters of computer application from HBTU-kanpur I have done some internship's onsite and remote. Beside's programming, I enjoy eating food, practicing yoga and watching anime.


mriduls LinkdeIN mriduls Leetcode mriduls facebook

Quote of the hour:

I never in my wildest dreams would have predicted the evolution of the Internet. And I never would’ve predicted the degree to which corporate influence over the Internet has changed its character over time.

~ L. Peter Deutsch

Languages and Tools:

react android cplusplus html5 javascript typescript mongodb mysql postgresql nodejs nginx


GIF

Talking about Personal Stuffs:

  • 👨🏽‍💻 I’m currently working on Node.js,React.js,Angular,MySql,Rxjs

  • 🌱 I am currently learning IPFS(peer2peer),docker,Flutter,Data Science.

  • 👯 I’m looking to collaborate on anything free and open source.

  • 🤔 I’m looking for help with Data Structures and Algorithms 😭;

  • 💬Ask me about react, Angular and nodejs

  • 📫 How to reach me: mridulshukla037@gmail.com;

GIF

mridul



Daily News

  • …







Alt Text

Discussion (0)