search

aws / aws-northstar

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, predictable user experience at scale for your customers. With NorthStar, you can focus on innovation and do more with less.
https://aws.github.io/aws-northstar
Apache License 2.0
208 stars 37 forks source link
aws-northstar design-system ui

readme

NorthStar - Prototyping Design System

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

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, predictable user experience 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 v2

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.

NorthStar v2 (@aws-northstar/ui) improves upon the previous version by leveraging Cloudscape Design System and with updates to the existing components with new features that make the development experience even better.

NorthStar Legacy

NorthStar legacy (aws-northstar), released in October 2020, was built using Material UI v4 as its base and provided approximately 50 components for building prototyping user experience. This version entered maintenance on April 1, 2023.

During the maintenance phase, NorthStar legacy will only receive critical bug fixes and security patches. New features will be exclusively developed for NorthStar v2. On April 1, 2024, support will end for NorthStar legacy.

Refer to the Migration tabs in the documentation website for more information on how to migrate NorthStar legacy to v2.

Development

Contribution guide are available at the Contributing Guidelines.

Folder Structure

This monorepo hosts source code for both NorthStar legacy and NorthStar v2.

Path
packages/legacy Source code for NorthStar legacy
packages/ui Source code for NorthStar v2
packages/examples/legacy Source code for NorthStar legacy demo app
packages/examples/ui Source code for NorthStar v2 demo app

Prerequisites

Commands

In the project directory, you can run:

yarn storybook

Runs storybook to navigate all the components on NorthStarv v2.

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

It is recommended to use storybook as development environment.

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