Skip to content

A collection of useful React components, built for modern browsers.

License

Notifications You must be signed in to change notification settings

suitejs/suitejs

Repository files navigation

SuiteJS 👌

Travis branch Codecov branch David Commitizen friendly styled with prettier js-standard-style license

A collection of useful React components, built for modern browsers.

This is a Lerna based repository. If you want to work with this project, it will be necessary to be comfortable with this tool.

Packages

Package Version Dependencies DevDependencies
@suitejs/icon-base npm (scoped) David
@suitejs/icons npm (scoped) David

Built with

Back to top

Prerequisites

Back to top

Installing / Getting started

First up, clone the repository and change in to the root directory.

Make sure you are running Node v8.*. If you use NVM, you can simply run:

$ nvm use

If Node v8.* isn't available, run:

$ nvm install

This will download, install and switch to the latest Node v8.*.

Next, install the dependencies:

$ npm install

Finally, 'bootstrap' the packages [1]:

$ lerna bootstrap
$ lerna run validate

And that's pretty much it! The bootstrap/validate steps should have gone without a hitch 🤞.

Back to top


[1] The validate script is used in place of NPM's prepublish life-cycle hook, called when using lerna bootstrap. It is used to prep the packages for release. It runs the following tasks:

  • clean
  • lint
  • test
  • build:*

We don't use prepublish, prepare, or prepublishOnly life-cycle hooks as these behave differently across different versions of NPM (and are also poorly documented).

Unfortunately, at the time of writing, there doesn't appear to be a life-cycle hook where we can perform these tasks ONLY prior to packing and publishing (with backwards compatibility), that won't be run by consumers of the package.

Back to top

About

A collection of useful React components, built for modern browsers.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published