aws-northstar icon indicating copy to clipboard operation
aws-northstar copied to clipboard

NorthStar is an open source design system with reusable React components for rapidly prototyping intuitive, meaningful and accessible user experience. It simplifies your work and ensures consistent, p...

NorthStar - Prototyping Design System

CodeBuild Status Github Action Workflow - CI NPM latest version Coverage Status GitHub Release Date NPM Download NPM type definitions Github license GitHub pull-requests GitHub issues GitHub issue resolution

NorthStar aims to be the standard for rapidly prototyping intuitive, meaningful and accessible user experiences. It simplifies your work and ensures consistent, predictable experiences at scale for your customers. With NorthStar, you can focus on innovation and do more with less.

Check out our documentation website for more details.

Cloudscape Design System and NorthStar

On July 19, 2022, AWS released Cloudscape Design System as open source. Cloudscape is a solution for building intuitive user experiences. It offers guidelines to create web applications, along with the design resources and front-end components to streamline implementation. While NorthStar is a design system to rapidly prototype user experiences, Cloudscape is a design system that is intended for use in production environments, beyond the prototypal phase.

Development

Contribution guide and coding guidelines are available at the documentation website.

Prerequisites

Commands

In the project directory, you can run:

yarn storybook

Runs storybook to navigate all the components.

Open http://localhost:9090 to view it in the browser. The page will reload if you make edits.

It is recommended to use storybook as development environment.

yarn styleguide

Runs documentation site to navigate all the components.

Open http://localhost:6060 to view it in the browser. The page will reload if you make edits.

yarn test:watch

Run jest tests in watch mode

yarn lint:fix

Fix lint problems automatically

yarn check:all

Check all the tests passed, code built, storybook built, documentation built

License

This project is licensed under the Apache-2.0 License.

Changelog

Check out the Changelog