component-boilerplate
You can view a demo here;
Quick Start
npm i
npm run i:demo
npm start
Publishing
In order to publish and deploy your new package via TravisCI, you need to go through the following three steps.
-
Modify the
.travis.yml
with your own npm details. The simplest way to do this is by following this guide or runningtravis setup npm
. -
To deploy the demo to a gh-pages branch you need to make a Github token with
repo
access onprocess.env.GITHUB_TOKEN
or runtravis encrypt -r GITHUB_TOKEN=[the token here]
to add it to your travis.yml. Be warned if you have collaborators, this gives access to all repositories. Note: A project specific SSH key would prove safer. Look into adding this.
Finally once the above has been set up, you can run npm version <newversion>
as per the npm docs. This will create a tagged commit that is pushed to the repository and will start the TraviCI process deployment process.
TODO
- Install demo dependencies as post install
- Better build logging
- Remove
dist
from importing css files. - define plugin for
process.env
variables. - Document