generator-kyper-library

Starting place for ESNext library. Uses webpack run through npm scripts to build.

Usage no npm install needed!

<script type="module">
  import generatorKyperLibrary from 'https://cdn.skypack.dev/generator-kyper-library';
</script>

README

generator-kyper-library

NPM version Build Status Dependency Status npm downloads license code-style

Starting place for ESNext libraries using Webpack

Installation

First, install Yeoman and generator-kyper-library using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-kyper-library

Then generate your new project:

yo kyper-library

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.

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

License

MIT © Scott Prue