search

okp4 / ui

🎨 Implementation of OKP4 UI components in React, TypeScript, and SASS.
https://ui.okp4.space/
BSD 3-Clause "New" or "Revised" License
28 stars 2 forks source link
ddd event-sourcing hexagonal-architecture react sass storybook typescript ui-design web3

readme

OKP4 UI

Implementation of OKP4 UI components in CSS, Typescript, and HTML.

Version NPM Install Size Lint Build Maintainability Test Coverage FOSSA Status

TypeScript React Sass Storybook Yarn Prettier Conventional Commits License

Our vision

The OKP4 Design System is a collection of clear guidelines, components, and resources that was created to aid in the design and development of our digital products - primarily our web apps or websites - for our customers.

The OKP4 Design System serves as a reference or source of truth for the teams working on OKP4 digital products, enabling to design and develop with speed, consistency, and quality.

Get started

The OKP4 Design System contains a collection of React components that can be used to build accessible and performant React applications consistent with OKP4 brand guidelines.

Build

🚚 Install the dependencies:

yarn

🚀 Start Storybook and 👨‍💻 start editing.

yarn storybook

Use

To get started using @okp4/ui first add or install the module to your existing React project using either yarn or npm.

yarn add @okp4/ui

or

npm install --save @okp4/ui

Contributing

So you want to contribute? Great. We appreciate any help you're willing to give. Don't hesitate to open issues and/or submit pull requests.

Remember that this is the Design System we use at OKP4. This is why we may have to refuse change requests simply because they do not comply with our internal requirements, and not because they are not relevant.