Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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://github.com/aws/aws-northstar
aws-northstar design-system ui
Last synced: 27 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/aws/aws-northstar
- Owner: aws
- License: apache-2.0
- Created: 2020-09-16T23:15:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T06:57:18.000Z (about 1 month ago)
- Last Synced: 2024-10-04T21:04:50.623Z (about 1 month ago)
- Topics: aws-northstar, design-system, ui
- Language: TypeScript
- Homepage: https://aws.github.io/aws-northstar
- Size: 23.1 MB
- Stars: 208
- Watchers: 13
- Forks: 37
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# NorthStar - Prototyping Design System
[](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiTm9JSkpnb2IrV09tcGcwU2E5c0diN1lJaVdkbEQza0FoeVVpWnljb3hSZHBEb09mS1pCMmwva3R5SXlYa2Fqem1NVVUrNGJaSFVMTCt5R1VKZ1hDRm5FPSIsIml2UGFyYW1ldGVyU3BlYyI6Ijkyd2FEMFc5cmlmN3hxUnYiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=main)
[](https://github.com/aws/aws-northstar/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/@aws-northstar/ui)
[](https://coveralls.io/github/aws/aws-northstar?branch=main)
[](https://github.com/aws/aws-northstar/releases)
[](https://www.npmjs.com/package/@aws-northstar/ui)
[](https://github.com/aws/aws-northstar/blob/main/LICENSE)
[](https://github.com/aws/aws-northstar/pulls)
[](https://github.com/aws/aws-northstar/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](https://aws.github.io/aws-northstar) for more details.
## Cloudscape Design System and NorthStar v2
On July 19, 2022, AWS released [Cloudscape Design System](https://cloudscape.design/) 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](https://cloudscape.design/) 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](https://v4.mui.com/) 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](https://aws.github.io/aws-northstar/?path=/story/migration-migratingfromlegacy--page) for more information on how to migrate NorthStar legacy to v2.
## Development
Contribution guide are available at the [Contributing Guidelines](https://github.com/aws/aws-northstar/blob/main/CONTRIBUTING.md).
### 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
* [git-secrets](https://github.com/awslabs/git-secrets#installing-git-secrets)
### Commands
In the project directory, you can run:
#### `yarn storybook`
Runs storybook to navigate all the components on NorthStarv v2.
Open [http://localhost:6006](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](https://github.com/aws/aws-northstar/releases)