https://github.com/wzulfikar/vue-github-commits
Vue component for github commits: https://wzulfikar.github.io/vue-github-commits/
https://github.com/wzulfikar/vue-github-commits
commits github vue
Last synced: about 2 months ago
JSON representation
Vue component for github commits: https://wzulfikar.github.io/vue-github-commits/
- Host: GitHub
- URL: https://github.com/wzulfikar/vue-github-commits
- Owner: wzulfikar
- Created: 2017-03-10T02:14:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-11T19:17:40.000Z (over 9 years ago)
- Last Synced: 2026-02-20T07:41:11.679Z (4 months ago)
- Topics: commits, github, vue
- Language: JavaScript
- Homepage: https://wzulfikar.github.io/vue-github-commits/
- Size: 87.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vue-github-commits
[ ](https://www.npmjs.com/package/vue-github-commits)
[](https://vuejs.org/)
A Vue.js Plugin
## Table of contents
- [Generator](#generator)
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
# Generator
Visit https://wzulfikar.github.io/vue-github-commits
# Installation
```
npm install --save vue-github-commits
```
## Default import
Install all the components:
```javascript
import Vue from 'vue'
import VueGithubCommits from 'vue-github-commits'
Vue.use(VueGithubCommits)
```
Use specific components:
```javascript
import Vue from 'vue'
import { Test } from 'vue-github-commits'
Vue.component('test', Test)
```
**⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.**
## Distribution import
Install all the components:
```javascript
import 'vue-github-commits/dist/vue-github-commits.css'
import VueGithubCommits from 'vue-github-commits/dist/vue-github-commits.common'
Vue.use(VueGithubCommits)
```
Use specific components:
```javascript
import 'vue-github-commits/dist/vue-github-commits.css'
import { Test } from 'vue-github-commits/dist/vue-github-commits.common'
Vue.component('test', Test)
```
**⚠️ You may have to setup your bundler to embed the css file in your page.**
## Browser
```html
```
The plugin should be auto-installed. If not, you can install it manually with the instructions below.
Install all the components:
```javascript
Vue.use(VueGithubCommits)
```
Use specific components:
```javascript
Vue.component('test', VueGithubCommits.Test)
```
## Source import
Install all the components:
```javascript
import Vue from 'vue'
import VueGithubCommits from 'vue-github-commits/src'
Vue.use(VueGithubCommits)
```
Use specific components:
```javascript
import Vue from 'vue'
import { Test } from 'vue-github-commits/src'
Vue.component('test', Test)
```
**⚠️ You need to configure your bundler to compile `.vue` files.** More info [in the official documentation](https://vuejs.org/v2/guide/single-file-components.html).
# Usage
> TODO
# Example
> TODO
---
# Plugin Development
## Installation
The first time you create or clone your plugin, you need to install the default dependencies:
```
npm install
```
## Watch and compile
This will run webpack in watching mode and output the compiled files in the `dist` folder.
```
npm run dev
```
## Use it in another project
While developping, you can follow the install instructions of your plugin and link it into the project that uses it.
In the plugin folder:
```
npm link
```
In the other project folder:
```
npm link vue-github-commits
```
This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.
## Publish to npm
You may have to login to npm before, with `npm adduser`. The plugin will be built in production mode before getting published on npm.
```
npm publish
```
## Manual build
This will build the plugin into the `dist` folder in production mode.
```
npm run build
```
---
## Screenshot
## License
[MIT](http://opensource.org/licenses/MIT)