/aws-northstar

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.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

NorthStar - Prototyping Design System

CodeBuild Status Travis CI Status NPM latest version Coverage Status NPM Download Snyk Vulnerabilities for npm package 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.

Development

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

Prerequisites

Commands

In the project directory, you can run:

npm run 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.

npm run 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.

npm run test:watch

Run jest tests in watch mode

npm run lint:fix

Fix lint problems automatically

npm run check:all

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

License

This project is licensed under the Apache-2.0 License.