onyx-lib

Onyx

This repo houses both the Onyx React component library for building modern UI at Securonix, and the Storybook-driven docs site for those components.

Getting Started

Pre-requisites

• Node (version: current LTS) - NVM recommended [win - mac/linux]
• yarn

Running Locally

• git clone [e-mail]:securonixsnypr/onyx-library.git – Clone this repo
• yarn – install dependencies
• yarn prepare – Setup
• yarn start or yarn storybook – Launch storybook

Guides

• Editor Setup
• Testing / Linting / Formatting
• Git / Branching Guide
• Dark Mode / Themes

Resources

• Figma Design file list

Update dependencies

• npx yarn-upgrade-all - update all dependencies at once (potentially across major versions)

Publish

Publish component library

TODO

Deploy Docs site

• yarn build-storybook – Build the static Storybook instance to ./storybook-static
• TBD - Deploy step

Questions?

• Contact Preston Mitcham, or Paul Sroufe on Slack