Getting Started

Getting Started as a Contributor to Paprika

Environment

Paprika depends on Node v10.0.0+ and Yarn v1.12.3+.

NPM on its own will not be sufficient as we use Lerna, which makes use of Yarn Workspaces.

Clone

First step is to clone the Paprika repository:

$ git clone [email protected]:acl-services/paprika.git

Build

Next, install dependencies:

$ yarn

And link packages with the Lerna

$ npx lerna bootstrap

It will also be necessary to run this command if you are modifying two components at once. For example, code changes to the <Collapsible> component will be visible immediately in the stories for that component, but changes to the <Icon> component will not be visible in the stories for the <Collapsible> until packages are relinked.

More info about Lerna's bootstrap command.

Run

Paprika is not an application, it is a library. To develop components, we use Storybook for React which is deployed automatically from master to paprika.highbond.com.

To run the Storybook locally:

$ yarn storybook

The Storybook should launch automatically in your default browser at http://localhost:9009/.