https://github.com/lexmartinez/vue-github-activity

:octocat: A Vue based github feed activity component.
https://github.com/lexmartinez/vue-github-activity

github github-activity vue-component vuejs

Last synced: 6 months ago
JSON representation

:octocat: A Vue based github feed activity component.

• Host: GitHub
• URL: https://github.com/lexmartinez/vue-github-activity
• Owner: lexmartinez
• License: mit
• Created: 2018-04-02T15:09:02.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-02-16T16:44:56.000Z (almost 7 years ago)
• Last Synced: 2024-11-13T14:54:01.454Z (about 1 year ago)
• Topics: github, github-activity, vue-component, vuejs
• Language: Vue
• Size: 690 KB
• Stars: 28
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# vue-github-activity

[![Build Status](https://img.shields.io/travis/lexmartinez/vue-github-activity/master.svg?style=for-the-badge)](https://travis-ci.org/lexmartinez/vue-github-activity)

[![GitHub license](https://img.shields.io/github/license/lexmartinez/vue-github-activity.svg?style=for-the-badge)](https://github.com/lexmartinez/vue-github-activity/blob/master/LICENSE.md)

[![Last version](https://img.shields.io/badge/version-v2.1.1-blue.svg?style=for-the-badge)](https://github.com/lexmartinez/vue-github-activity/blob/master/CHANGELOG.md)




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](https://github.com/caseyscarborough/github-activity) repository.

See it in action on [my website](https://lexmartinez.com/)

![](https://github.com/lexmartinez/vue-github-activity/raw/master/screenshot.png)

## Installation

`npm install --save vue-github-activity`

## Dependencies

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

```html

```

> 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.

```javascript

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: 

```html

```

## License

This project is licensed under MIT License - see the [LICENSE.md](https://github.com/lexmartinez/vue-github-activity/blob/master/LICENSE.md) file for details