README
reside
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Code Climate][climate-image]][climate-url] [![License][license-image]][license-url] [![Code Style][code-style-image]][code-style-url]
Getting Started
reside is universal, so it can be used client-side or server-side.
Install through:
npm install --save reside
Include and use
reside
:
import Reside from 'reside'; let reside = new Reside();
## Testing/Coverage
`npm run test` - Run unit tests
`npm run test:cov` - Run unit tests and report coverage
## Building Bundle
Build code before deployment by running `npm run build`. There are multiple options below for types of deployment, if you are unsure, checkout the Firebase section.
### Tests
`npm run test` - run tests
`npm run test:cov` - run tests and generate coverage
### Travis
Visit [travis](travis-ci.org) to enable your gihub repo. Builds settings can be changed in `.travis.yml`
### Deployment
#### AWS S3
Selecting AWS S3 from the deploy options when running the generator adds deploy configs in `.travis.yml`.
1. Get your AWS Key and Secret from the AWS Console Credentials page
2. Set the following environment vars within the Travis-CI repo settings page:
* `AWS_KEY` - Your AWS key
* `AWS_SECRET` - Your AWS secret
* `S3_BUCKET` - Your S3 Bucket
### Code Climate
Visit [code climate dashboard](https://codeclimate.com/dashboard) to enable codeclimate for your repo on Github. Coverage will be sent automatically by Travis.
Get the key from the settings->coverage page and place it in Travis environment variable as `CODE_CLIMATE`
## [Documentation](https://prescottprue.github.com/reside)
[npm-image]: https://img.shields.io/npm/v/reside.svg?style=flat-square
[npm-url]: https://npmjs.org/package/reside
[travis-image]: https://img.shields.io/travis/prescottprue/reside/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/prescottprue/reside
[daviddm-image]: https://img.shields.io/david/prescottprue/reside.svg?style=flat-square
[daviddm-url]: https://david-dm.org/prescottprue/reside
[climate-image]: https://img.shields.io/codeclimate/github/prescottprue/reside.svg?style=flat-square
[climate-url]: https://codeclimate.com/github/prescottprue/reside
[coverage-image]: https://img.shields.io/codeclimate/coverage/github/prescottprue/reside.svg?style=flat-square
[coverage-url]: https://codeclimate.com/github/prescottprue/reside
[license-image]: https://img.shields.io/npm/l/reside.svg?style=flat-square
[license-url]: https://github.com/prescottprue/reside/blob/master/LICENSE
[code-style-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[code-style-url]: http://standardjs.com/