@openred-security/orui
v1.0.1
Published
openred UI Component Library
Downloads
2
Readme
openred UI Framework
Welcome!
The openred UI (ORUI) Framework is a collection of React UI components for quickly building user interfaces for the openred project.
This repository started as a fork from OpenSearch OUI. As we stated here https://github.com/openred-security/openred-orui/issues/1 we really want to thanks and give credit to its original creators.
Just to make it clear, from the first commit, our intention is not to hide OpenSearch or rename the project. We are proud to use OpenSearch components and enhance, adapt, and prepare them to better fit the openred use case.
openred will always remain a full, complete, and open source project in every possible aspect. This is not only because we must respect the license of the project we integrate but also because openred genuinely believes in the foundational values and community of open source.
You should check out our living style guide, which contains many examples of components in the ORUI framework aesthetic, and how to use them in your products. We also have a FAQ that covers common usage questions.
Goals
The primary goal of this library is to provide reusable UI components that can be used in any openred web project. As React components, they remove CSS from the process of building UIs. As a single source of truth, the framework allows our designers to make changes to our aesthetic directly in the code. And unit test coverage for the UI components allows us to deliver a stable "API for user interfaces".
Installation
To install the openred UI Framework into an existing project, use the yarn
CLI (npm
is not supported).
yarn add @openred-security/orui
Note that ORUI has several peerDependencies
requirements that will also need to be installed if starting with a blank project. You can read more about other ways to consume ORUI.
Project Resources
- FAQ
- Contributing to OpenSearch
- Maintainer Responsibilities
- Release Management
- Organization Admins
- Repo Maintainers
- Security
Code of Conduct
This project has adopted the Contributor Covenant.
License
This project is licensed under the Apache v2.0 License.
Copyright
Copyright openred Contributors. See NOTICE for details.
This product includes software, including OUI source code, developed by OpenSearch (http://www.opensearch.org).