reside
v0.0.1
Published
[![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]][co
Downloads
4
Readme
reside
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 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
.
- Get your AWS Key and Secret from the AWS Console Credentials page
- Set the following environment vars within the Travis-CI repo settings page:
AWS_KEY
- Your AWS keyAWS_SECRET
- Your AWS secretS3_BUCKET
- Your S3 Bucket
Code Climate
Visit code climate 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