pupubird / get-github-trending

A self-hosted version of https://github.com/huchenme/github-trending-api

Get Github Trending

A self-hosted version of https://github.com/huchenme/github-trending-api

Demo

Check out the demo here! https://hackertab.pupubird.com/repositories

📝 Table of Contents

• Getting Started
• Deployment
• Usage
• TODO
• Built Using
• Acknowledgments

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

For manual install:

npm i

or with docker

docker build .

🚀 Deployment

This project is configured with serverless, hence simply run:

serverless deploy

🎈 Usage

For nodejs only:

npm run start

Go to your localhost and try access to /repositores!

For more information on the API, you may refer to https://github.com/huchenme/github-trending-api or https://githubtrendingapi.docs.apiary.io/#

📃 TODO

• Implement core trending repositories API
• Implement trending developers API
• Implement list of spoken languages API
• Implement list of languages API

⛏️ Built Using

• CheerioJS - Web Scraper
• Express - Server Framework

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• The inspiration is coming from https://github.com/huchenme/github-trending-api, credit of the idea goes to him!