retrosockets-ui-utils

Component Library Starter

a library of common utils for RetroSockets

Installation

This package is available on npm as retrosockets-ui-utils, and you can find it here.

To install the latest stable version with yarn:

$ yarn add retrosockets-ui-utils

or with npm:

$ npm install retrosockets-ui-utils --save

Up & Running

To install dependencies with Yarn, run:

$ yarn

or to install with npm, run:

$ npm install

Local Development

Module Development Workflow

Helpful information on development workflow in this library lives here.

Linting

This assumes you have eslint and eslint-watch installed. If you don't, run the following:

$ npm i -g eslint eslint-watch

or if you need permissions:

$ sudo npm i -g eslint eslint-watch

To run the linter once:

$ yarn lint

To run the watch task:

$ yarn lint:watch

Review

If you'd like to run the linters and tests at once (this is a nice check before pushing to Github or deploys), you can run:

$ npm run review

Build

NOTE: When you run build, Babel will create a build directory. This is what your users will interact with when they use your library. Nothing in lib gets shipped with your published module.

Run once:

$ npm run build

Run the watch script:

$ npm run build:watch

NOTE: the build script runs in the prepublish script just before you publish to npm.

Publishing

If you already have an account with npm, you can simply run:

$ npm login
$ npm publish

If you don't have an account with npm:

NOTE: Your email address is public

$ npm set init.author.name "Your Name"
$ npm set init.author.email "[e-mail]"
$ npm set init.author.url "http://yourblog.com"
$ npm adduser
$ npm publish

Contributing

I am thankful for any contributions made by the community. By contributing you agree to abide by the Code of Conduct in the Contributing Guidelines.

License

MIT