Skip to content
:octocat: A Vue based github feed activity component.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

vue-github-activity

Build Status GitHub license Last version

Simple VueJS component that creates a feed panel with your recent GitHub activity. It displays the user's name, username, photo, and a list of each individual activity type.

Inspired by caseyscarborough/github-activity repository.

See it in action on my website

Installation

npm install --save vue-github-activity

Dependencies

Insert an octicons.css file in your html file to load the icons.

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/octicons/3.5.0/octicons.min.css">

Also axios http client and moment are required as dependencies of your host project use npm install --save axios moment to include them

Usage

The most common use case is to register all the components globally.

import Vue from 'vue'
import VueGithubActivity from 'vue-github-activity'

Vue.use(VueGithubActivity)

On your template you can now use html like this to render the activity feed:

<github-feed login="lexmartinez"></github-feed>

License

This project is licensed under MIT License - see the LICENSE.md file for details

You can’t perform that action at this time.