@earnest/nucleus v0.2.16

Nucleus Design System

What is Nucleus?

Nucleus is Earnest’s design system, and is in early development at the time of writing (May 2022). It will be comprised of a style guide on Earnest’s digital foundations, a Figma component library, and a React component library, all tied together with a single documentation website.

What are Nucleus' goals?

:rocket: Improve product development velocity

:paintbrush: Make our products more consistent and trustworthy

:wheelchair: Make accessibility a first-class citizen in all of our experiences

What is Nucleus not?

A set of higher-level components.

Nucleus is built following the Atomic Design methodology. It is built on the foundation of low-level components that can be composed to build larger patterns and pages.

A place to share front-end logic.

Nucleus is a design system. The React library is responsible for rendering UI components. It might include some low-level hooks and other utilities, but only if they are within the domain of the design system.

Tech Stack

Nucleus is built using React along with styled-components. Vite is used as the build engine and documentation is handled with Storybook (link coming soon).

Installation

In your project directory in terminal simply add Nucleus as an NPM module.

npm -i --save @earnest/nucleus
or
yarn add @earnest/nucleus

Setup

Nucleus uses the <ThemeProvider /> supplied by the Styled Components package. You can use this component to pass in your own custom theme to overwrite the default Nucleus design tokens.

All components can be used using the import { ComponentName } from '@earnest/nucleus' syntax.

License

Copyright Earnest 2022

ISC License

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.