❤
npm
Sign UpSign In

v-github-activity

2.1.0 • Public • Published

v-github-activity

Made with vue Made with vue npm npm bundle size NPM

Componente Vue.js para mostrar la actividad de github.

Puedes encontrar algunos ejemplos aquí

Instalación

npm install v-github-activity

Uso

v-avatar es un modulo UMD, por lo que puede ser utilizado en tanto en una instancia de Vue como en Nuxt como en un entorno non-modular donde githubFeed sera registrada como variable global.

VUE COMPONENT

<template>
<div>
  <github-feed login="amaury-tobias" token='xxxxx'/>
</div>
</template>
 
<script>
import githubFeed from 'v-github-activity'
 
export default {
  components: {
    githubFeed
  }
}
</script>

OR GLOBAL

import Vue from 'vue'
import githubFeed from 'v-github-activity'
 
Vue.use(githubFeed)

NUXT

./plugins/githubActivity.js

import Vue from 'vue'
import githubFeed from 'v-github-activity'
 
Vue.use(githubFeed)

nuxt.config.js

module.exports = {
  plugins: ['~/plugins/githubActivity.js']
}

*.vue <template>

<github-feed login="amaury-tobias" token="xxxxx" />

Browser

<!DOCTYPE html>
<html>
  <head>
    <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script> 
    <script src="https://unpkg.com/v-github-activity"></script> 
  </head>
  <body>
    <div id="app">
      <github-feed login="amaury-tobias" token="xxxxx" />
    </div>
    <script>
      var app = new Vue({
        el: '#app',
        components: {
          githubFeed
        }
      })
    </script> 
  </body>
</html>

Props

Name Required Default Type Description
login Y - String GitHub username
token N - String Github Personal access tokens "OAUTH-TOKEN" to increase the api rate_limit

Build Setup

# install dependencies 
npm install
 
# serve whith hot reload al localhost:8080 
npm run serve
 
# build 
npm run build

Test

npm test

License

Released under the MIT License.

TO DO

  • Unit testing

Readme

Keywords

Package Sidebar

Install

npm i v-github-activity

Repository

github.com/amaury-tobias/v-github-activity

Homepage

github.com/amaury-tobias/v-github-activity#readme

Weekly Downloads

1

Version

2.1.0

License

MIT

Unpacked Size

134 kB

Total Files

25

Last publish

Collaborators

  • amaury-tobias
Try on RunKit
Report malware