README
Circuit UI Web is the web implementation of the SumUp Circuit Design System. Our primary goal is to create a system that can be used to build a wide variety of SumUp websites and apps, while providing a consistent and inclusive user experience to our end users. In addition, the design system and component library should be easy to use for developers and designers.
Quick start
Here are a few helpful links for getting started with Circuit UI:
- Documentation - Learn how to use Circuit UI and view the components in Storybook.
- Getting started - Set up a new app with Circuit UI or add it to an existing project.
- Theming - Learn about our foundations such as colors, spacing, and typography.
- Contribute - File a bug report, suggest a change, or open a pull request.
Packages
- @sumup-oss/circuit-ui — the core React component library
- @sumup-oss/design-tokens — visual primitives such as typography, color, and spacing
- @sumup-oss/icons — a collection of SVG icons
- @sumup-oss/eslint-plugin-circuit-ui — ESLint rules to help users follow best practices when using Circuit UI
- @sumup-oss/stylelint-plugin-circuit-ui — Stylelint rules to help users follow best practices when using Circuit UI