Component SubwayBite Vuejs

Vue SubwayBite Template Component

Synopsis

To deliver transit information based on location

Code Examples

Install:

npm install component-subwaybite-vuejs --save

Usage:

Vue.use(SubwayBite, options);

or within existing components:

import SubwayBite from 'component-subwaybite-vuejs';

export default {
    components: {
        SubwayBite
    }
}

Installation

Install dependencies:

npm install

Copy .env.example to create .env:

cp .env.example .env

Copy config files over:

cp ./src/config/build.js ./src/config/development.js

Serve with hot reload at localhost:8080 (default):

npm run dev

Build for production with minification:

npm run build

Documentation

Properties

Name | Type | Description ------------- | ------------- | ------------- url | String | The base url origin for api end point token | String | API access token limit | Number | Limits the number of items shown in the widget [6] term | String | Type of transportation (Options: bus) dma | Number | Stop ID

Test

All widgets should have unit tests associated with them. To run all tests

npm test

For developments test with hot reloading at localhost:3001

npm run test:dev

To run tests with coveralls support:

npm run test:coveralls

Style 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 lint

To fix eslint errors:

npm run lint:fix

Local Setup

• Atom: docs
• Sublime: docs