component-moviebite-vuejs
v1.0.17
Published
Vue Moviebite Widget Component
Readme
Component Moviebite Vuejs
Vue Moviebite Template Component
Synopsis
To deliver the top movies currently in theaters
Code Examples
Install:
npm install component-moviebite-vuejs --saveUsage:
Vue.use(Moviebite, options);or within existing components:
import Moviebite from 'component-moviebite-vuejs';
export default {
components: {
Moviebite
}
}Installation
Install dependencies:
npm installCopy .env.example to create .env:
cp .env.example .envCopy config files over:
cp ./src/config/build.js ./src/config/development.jsServe with hot reload at localhost:8080 (default):
npm run devBuild for production with minification:
npm run buildDocumentation
Properties
Name | Type | Description
------------- | ------------- | -------------
url | String | The base url origin for api end point
token | String | API access token
type | String | Type of parameter being sent (Options: in-theaters,opening, upcoming) [in-theaters]
limit | Number | Limits the number of items shown in the widget [6]
sortBy | String | Sorting the movie results (Options: popularity, release, tomato) [popularity]
showTitle | Boolean | Options to display or hide heading [true]
layout | String | Layout to show the tweets (Options: swiper, list, grid) [swiper]
Test
All widgets should have unit tests associated with them. To run all tests
npm testFor developments test with hot reloading at localhost:3001
npm run test:devTo run tests with coveralls support:
npm run test:coverallsStyle Guide
All project should follow JS Style guide. Style guide is a modified version of airbnb, and should be referenced during development. Any modified rules can be found in .eslintc.json file.
To run eslint:
npm run lintTo fix eslint errors:
npm run lint:fix