SCORER UI KIT is a UI components library created in react for faster web applications development.
You can review online a React project example and test some of the components on storybook in the live page
https://future-standard.github.io/scorer-ui-kit
For production projects, at this time we recommend using v1 from the main-v1.x branch.
If you require dark mode functionality for your UI then v2 has the initial version of this available. However, with version 2 you may find in the future that updating the UI Kit version may cause breaking changes that require additional attention from developers to ensure your UI is still functioning as expected. In this case you may want to manually set a specific version in your package.json to stop unexpected version update of your UI kit.
Legacy version, no mayor updates are made but will continue to do fixes. main-v1.x
Our default branch is Version 2 release but we keep a legacy branch available. This version provides dark mode, the newest components and tools as well as been up to date with npm dependencies. At this time, progress on Version 2 is delayed and may be expected to bring many breaking changes as it can accelerate.
Detailed information about theme, dark and light mode can be read in Settings for dark and light mode document.
This repository is holding the ui library with examples using 3 workspaces:
storybook is a showcase of some of the components in the ui lib.
For a quick guide on how to use it please review the ui-lib README.
The Scorer UI Kit is released under the MIT license.
Please note however that the icon set included in this software is included under license and remains property of Webalys LLC. These icons can be used only in the context of this open source project. For more information regarding this license, see Streamline Icons Premium License.
If you have any questions about this repository please contact @isacodes, @atomworks or @JoshLipps.