@worldvision/ui-components

WorldVision UI components

https://wvidigital.github.io/WVUnited-React-UI-Components

Table of Contents

• Installation & Usage
  • Prerequisites
• Installing dependencies
• Storybook
• Development
• Deployment
• API
  • Theme
  • Components

Installation & Usage

Prerequisites

• Clone the repository
• Install yarn

Installing dependencies

yarn

Storybook

Use following command to serve a storybook server:

yarn storybook

Storybook server will be started at http://localhost:9001

Development

To link this package, run following command in the @worldvision/ui-components root folder:

yarn link

Run following to start webpack in watch mode:

yarn dev

This is important to keep running while developing on the consumer/app. Everytime a file changes, webpack creates a new build and the app will show the latest updates.

Move to the the consumer/app's repository's root folder and run following command:

yarn link @worldvision/ui-components

To confirm that this has worked, you can check the node_modules/@worldvision/ui-components folder if this symlinks to your local ui-components folder.

Start the consumer/app server and then you're ready to go!

Deployment

Run following command to deploy to GitHub pages

yarn deploy

The deployed storybook will be available under https://wvidigital.github.io/WVUnited-React-UI-Components.

API

Theme

This repository contains a foundational theme scheme of:

• 🎨 A palette of colors
• 🚀 A scale of spaces
• 🖥 Typography
• ✨ And more

Our current theme can be found here.

These constrains are based on design principles which allows us to keep our design consistent across components.

Components

Full list of components here.

List of components to be refactored here.