Awesome
<p align="center"> <img src="https://user-images.githubusercontent.com/1626923/157498695-885de6c5-deba-416d-8287-51e7269aef56.png" alt="Storefront UI" /> </p> <h3 align="center"> Framework-agnostic UI library and Design System for eCommerce based on <a href="https://tailwindcss.com/">TailwindCSS</a>. </h3> <p align="center"> <a href="https://discord.gg/vuestorefront"> <img alt="Chat with us on Discord" src="https://img.shields.io/discord/770285988244750366?label=join%20discord&logo=Discord&logoColor=white" /> </a> <img alt="npm" src="https://img.shields.io/npm/v/@storefront-ui/vue"> <a href="http://commitizen.github.io/cz-cli/"> <img alt="Commitizen friendly" src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" /> </a> <a href="https://github.com/vuestorefront/storefront-ui"> <img alt="License" src="https://img.shields.io/github/license/vuestorefront/storefront-ui" /> </a> <a href="https://github.com/vuestorefront/storefront-ui/pulls"> <img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /> </a> </p> <hr> <div align="center"> <a href="https://docs.storefrontui.io/v2/vue/getting-started.html"><img alt="Vue Installation" height="40" width="120" src="./_readme/vuebtn.svg" /></a> <a href="https://docs.storefrontui.io/v2/react/getting-started.html"><img alt="React Installation" height="40" width="120" src="./_readme/reactbtn.svg" /></a> </div> <img src="./_readme/showcase.png">What problems does Storefront UI solve?
Like any UI Library / Design System the main goal of Storefront UI is to accelerate the development process by providing an opinionated set of premade components, utilities and patterns.
There is a lot of the things you have to take care of to build good user interfaces:
🔹 Developer/Designer workflow - Storefront UI comes out of the box with Figma files - a pixel-perfect representation of your code that your design and engineering teams needs to stay aligned.
🔹 Performance - Poorly written and overcomplicated components are often the performance bottleneck ruining the experience of your users. All standard eCommerce pages that we've built with Storefront UI hit 95-100 on Lighthouse! (mobile performance measured using PSI)
🔹 Accessibility - Web accessibility is more than an ethical requirement in the United States: it’s also legally mandated and you risk fines if the justice department determines your website is non-compliant. At the same time building accessible components takes a lot of time and requires specific domain knowledge. Storefront UI components are WCAG AA compliant out of the box!
But let's be honest, almost all established UI libraries can solve that. Here's what's Storefront UI is best at::
🔸 Customization - Most of the UI libraries out there fail when components need to be heavily customized. You suddenly find yourself working against your library just to achieve the desired look. Storefront UI is built for complex cases. We ship a set of small and flexible base components like Button, Checkbox or Modal that can be used to build more complex ones. We also deliver more complex examples (aka Blocks) like ProductCard or a different checkout steps as copy-pasteable code using Storefront UI components and Tailwind utilities.
In addition, Storefront UI fits perfectly complex UI setups where one library is inherited and customized by multiple projects differing visually.
🔸 Scaling - The more your application grows the less maintainable your UI becomes. By providing the right building blocks and using Tailwind CSS we made sure that your UI will be easy to maintain and won't negatively impact your performance even on a large scale.
🔸 Focus on eCommerce - Storefront UI comes out of the box with components specific to eCommerce like ProductCard, QuantitySelector and even checkout components
What comes out of the box? 🎁
- Base Components - beautiful, fast and fully accessible components like
InputCheckboxButtonthat you can use to quickly build more complex structures - Blocks - complex, copy-pasteable examples like
ProductCardor checkout steps. - Composables like
useDropdownthat abstract complex UI interactions - Tailwind preset that maps tailwind config to CSS variables and provides few SFUI-specific defaults
- Typography package simplifying usage of 3rd party fonts
- Figma file with pixel-perfect representation of SFUI components based on tailwind properties
<a href="https://www.figma.com/file/Q7Nr1NvjPdcGVhykkfDg2k/Storefront-UI-%7C-Design-Kit-v2.5-(public)?type=design&node-id=22913-91045&mode=design"><img src="./_readme/figma_included.png"></a>
Contributing
We believe that the best software is made when a lot of people with different views collaborate on it. We welcome all contributions to Storefront UI.
You can become contributor not only by writing code:
- Contribute to documentation
- Write an article or tutorial
- Help others on our Discord server
- Report a bug
- Do a talk about Storefront UI at your local meetup
We are grateful for all kind of contributions. If you don't know where to start check out our contribution guide or ask for help on Discord
How to run project locally
In the root directory of this project run yarn command to install all needed dependencies.
After dependencies has been installed run yarn dev command to run this project.
Now both (Nuxt preview for Vue and Next preview for React) projects are running locally and you can start working on them.
If you need to run only one of them, you need to run a desired preview from its directory, so you need to go for Vue: /apps/preview/nuxt and for React: /apps/preview/next.
NOTE: Subdependencies have to be build, such as
@storefront-ui/sharedlocated in/packages/sfui/shared@storefront-ui/tw-plugin-peer-nextlocated in/packages/sfui/tw-plugin-peer-next@storefront-ui/typographylocated in/packages/sfui/typography
Knowing this we recommend using yarn dev in root directory.