@locate-a-locum/react-components

 

---

 

React Component Library

A collection of React components that are used to build Locate a Locum's web products. Based on our common design system, the components aim to provide a consistent, high quality experience for users and developers alike.

Usage

Install

The component library is distributed via the public NPM Registry in the @locate-a-locum/react-components package:

yarn add @locate-a-locum/react-components

Note that this library has a number of peerDependencies that must be satisfied.

Import Components

import { Button } from '@locate-a-locum/react-components';

<Button>Locate a Locum</Button>

For full setup instructions, visit the Component Library Setup Page.

Built With

• Framework | React
• Language | TypeScript
• Styling | Styled-components + Styled-system
• Testing | Jest + react-testing-library
• Documentation | Invision DSM + Storybook
• Build & Deployment | Webpack + Github Actions + Heroku
• Linting | ESlint

Developer Contributions

Note: react-components development required node version 12.0. (if you have 12.0 installed, run nvm use 12.0.x - if you don't have 12.0.x installed, you can do this via nvm install 12.0.x )

• Check out the develop branch for initial development.
• Run yarn to install dependencies.
• Run yarn docs to run the local doc-site and test components.

Local Development against other repos

We use yalc to enable testing against local versions of other LaL repos.

Check out the Debugging against express-web-app repository article for information on setup.

Testing Locally

• yarn docs will start the doc site locally allowing you to perform some tests.
• yarn build will do a production build of the library.

Build and Release

For information on our contribution and release workflow, check out this Confluence article.

Release Notes

You can view an up to date changelog for the component library is the repositories Github release page.