README.md

GitHub API Client

GitHub REST API v3

Table of Contents

• Requirements
• App
  • Unix
    • Download
    • Run
  • Windows
    • Download
    • Run
• APIs
• API Usage Examples
  • Search
    • Repositories
    • Users
    • Commits
  • GitHub Emojis
  • Trending
    • Repositories
    • Developers
• Visuals
  • Home Page
  • Search Page
  • 404
  • API
• Tech
• Author

Requirements

• Docker Engine version 18.06.0+
• Docker-Compose version 1.22.0+

App

Unix

Unix Download

Run

./prod-run # http://localhost:80

Windows

Windows Download

Run

win_prod_run.bat 
REM http://localhost:80

APIs

• api/modules/
  • emojis.py & search.py utilizes GitHub REST API v3
  • trending.py scrapes data from https://github.com for trending repositories/developers

API Usage Examples

Search

Repositories

• Example 1

Response

{
    "headers":{
        ...
    },
    "items":[
        {
      "archive_url": "https://api.github.com/repos/freeCodeCamp/freeCodeCamp/{archive_format}{/ref}", 
      "archived": false, 
      "assignees_url": "https://api.github.com/repos/freeCodeCamp/freeCodeCamp/assignees{/user}", 
        ...
      "default_branch": "master", 
      "deployments_url": "https://api.github.com/repos/freeCodeCamp/freeCodeCamp/deployments", 
      "description": "freeCodeCamp.org's open source codebase and curriculum. Learn to code for free together with millions of people.", 
      "disabled": false, 
      ...
        },
        ...
    ],
    "status_code": 200
}

Users

• Example 2

Response

{
    "headers":{
        ...
    },
    "items": [
    {
      "avatar_url": "https://avatars3.githubusercontent.com/u/3190659?v=4", 
      "events_url": "https://api.github.com/users/Lightn/events{/privacy}", 
      "followers_url": "https://api.github.com/users/Lightn/followers", 
      "following_url": "https://api.github.com/users/Lightn/following{/other_user}", 
      "gists_url": "https://api.github.com/users/Lightn/gists{/gist_id}", 
      ...
    },
    ...
    ],
    "status_code": 200
}

Commits

• Example 3

Response

  {
      "headers":{
          ...
      },
  "items": [
    {
      "author": {
        "avatar_url": "https://avatars1.githubusercontent.com/u/17667652?v=4", 
        ...
        "login": "hareku", 
        "node_id": "MDQ6VXNlcjE3NjY3NjUy", 
        "organizations_url": "https://api.github.com/users/hareku/orgs", 
        "received_events_url": "https://api.github.com/users/hareku/received_events", 
        "repos_url": "https://api.github.com/users/hareku/repos", 
        "site_admin": false, 
        "starred_url": "https://api.github.com/users/hareku/starred{/owner}{/repo}", 
        "subscriptions_url": "https://api.github.com/users/hareku/subscriptions", 
        "type": "User", 
        "url": "https://api.github.com/users/hareku"
      }, 
      "comments_url": "https://api.github.com/repos/vuejs/vue/commits/841bb084ca288e142b1958346bb1182bf6f0a564/comments", 
      "commit": {
          ...
          }
    ...
    },
    ...
  ],
  "status_code": 200
  }

GitHub Emojis

• Example 4a

Response

{
    "headers":{
        ...
    },
  "items": {
    "+1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", 
    "-1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", 
    "100": "https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8", 
    "1234": "https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8",
    ...
  },
  "status_code": 200
}

• Example 4b

Trending

Repositories

• Example 5a
• Example 5b

Response

{
    "headers":{
        ...
    },
  "items": [
    ...
    {
      "author": "ahertel",
      "avatar": "https://github.com/ahertel.png",
      "built_by": [
        {
        "avatar": "https://avatars0.githubusercontent.com/u/3003066",
        "profile": "https://github.com/ahertel",
        "username": "ahertel"
        },
        {
        "avatar": "https://avatars3.githubusercontent.com/u/7012513",
        "profile": "https://github.com/antoniablair",
        "username": "antoniablair"
        }
    ],
      "description": "A Mac tool that finds available delivery slots for Amazon's Whole Foods delivery and Amazon Fresh services",
      "forks": 145,
      "language_color": "#101F1F",
      "name": "Amazon-Fresh-Whole-Foods-delivery-slot-finder",
      "present_freq_stars": "381 stars this week",
      "programming_language": "AppleScript",
      "stars": 874,
      "url": "https://github.com/ahertel/Amazon-Fresh-Whole-Foods-delivery-slot-finder"
    },
    ...
  ],
  "status_code": 200
}

Developers

• Example 6a
• Example 6b

Response

{
    "headers":{
        ...
    },
  "items": [
    {
      "avatar": "https://avatars0.githubusercontent.com/u/317464", 
      "name": "Sa\u00fal Ibarra Corretg\u00e9", 
      "popular_repository": {
        "description": "Python interface for libuv", 
        "name": "pyuv", 
        "url": "https://github.com/saghul/pyuv"
      }, 
      "profile": "https://github.com/saghul", 
      "username": "saghul"
    },
    ...
  ],
    "status_code": 200
}

Visuals

Home Page

Developers	Repositories

Search Page

Users	Repositories	Commits

404

API

Tech

• Environment

  • Docker
  • Docker-Compose

• Frontend

  • Vue.js
  • Vue Router
  • Vuex
  • Bootstrap

• Web Server

  • Nginx

• Backend

  • Gunicorn
  • Redis
  • Flask
    • Beautifulsoup4
    • Redis Cluster
    • Redis-Python-API
  • GitHub REST API v3

• Testing

  • Mamba

• Other

  • Node-Redis

Author

• Osarodion Irabor