README.md

FireComponent

A Vue.js Plugin for components wrapping Firebase integration.

Installation

npm install --save fire-component

Usage

Bundler (Webpack, Rollup)

import Vue from 'vue'
import FireComponent from 'fire-component'
// You need a specific loader for CSS files like https://github.com/webpack/css-loader
import 'fire-component/dist/fire-component.css'

Vue.use(FireComponent)

Browser

<!-- Include after Vue -->
<!-- Local files -->
<link rel="stylesheet" href="fire-component/dist/fire-component.css"></link>
<script src="fire-component/dist/fire-component.js"></script>

<!-- From CDN -->
<link rel="stylesheet" href="https://unpkg.com/fire-component/dist/fire-component.css"></link>
<script src="https://unpkg.com/fire-component"></script>

Development

Launch visual tests

npm run dev

Launch Karma with coverage

npm run dev:coverage

Build

Bundle the js and css of to the dist folder:

npm run build

Publishing

The prepublish hook will ensure dist files are created before publishing. This way you don't need to commit them in your repository.

# Bump the version first
# It'll also commit it and create a tag
npm version
# Push the bumped package and tags
git push --follow-tags
# Ship it 🚀
npm publish

License

MIT