Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 2.45 KB

README.md

File metadata and controls

42 lines (29 loc) · 2.45 KB
Raw

Watchit UIX - UI/UX Component Library

Watchit UIX is a UI/UX component library designed for reuse across multiple platforms, such as mobile, desktop, web, TV, and more. The library is built on three layers of abstraction which allow for modular and flexible interface building.

Layers of abstraction:

Atoms: Atom components are the most basic building blocks that make up the interface. These components should not depend on other elements and should be designed to be as independent as possible. Some examples of atoms include Input, Label, RoundProgress, Icon, and Logo.

Molecules: Molecule components are those that are mainly composed of atom components. These components are more complex and can include several atoms. Some examples of molecules include ChannelItem and Poster.

Organisms: Organism components are those that are mainly composed of molecule and atom components. These components are even more complex and can include several molecules and atoms. Some examples of organisms include MobileMenu and MobileHeader.

Installation

To install library dependencies. Open a terminal and run the following command:

npm install

Testing

The Watchit UIX library can be tested using the testing-library/react testing framework. To run all tests, use the following command:

npm run test

Storybook

Storybook is a tool that allows you to visualize and test components in isolation. To start Storybook in the Watchit UIX library, use the following command:

npm run storybook

Documentation

For more information about the Watchit UIX library, visit our website at watchit.movie. You can also read our post on dev.to for more information on how to use the library.

Support

If you need help or encounter any issues with the Watchit UIX library, please create an issue in our GitHub repository. You can also reach out to us on Gitter for additional help.

Contributing

If you would like to contribute to the Watchit UIX library, please submit a pull request to our GitHub repository. We welcome all contributions and work to integrate them as quickly as possible.

About Watchit and Synapse Media

Watchit and Watchit UI/UX are subproducts of Synapse Media, a company specializing in the development of media-related software and services. To learn more about Synapse Media and its products, visit synapsemedia.io.