Awesome Open Source
Awesome Open Source
Sponsorship

Vue Storefront - Headless PWA for any eCommerce

build:passed version Branch stable Branch Develop Branch Develop

Vue Storefront is a standalone PWA storefront for your eCommerce, possible to connect with any eCommerce backends, for example:

Vue Storefront is and always will be open source (MIT Licence). Anyone can use and support the project, we want it to be a tool for the improvement of the shopping experience. The project is in the production ready phase.

Links

How to start?

Which Vue Storefront should I choose for my next project?

  • If you’re on Magento 1 or Magento 2 choose Vue Storefront 1.x with vsf-capybara theme, Install it using CLI

  • If you’re on commercetools / About You Cloud choose Vue Storefront Next clone it from next

  • If you’re on Shopware 6 go to shopware-pwa sub-project and use the Shopware PWA powered by Vue Storefront

Check our Rodmap -> link do https://github.com/DivanteLtd/vue-storefront#roadmap

About Vue Storefront Next

We're developing a next version of Vue Storefront on the next branch.

We're building the following integrations within Next architecture:

  • Shopware 6 (developer preview)
  • Commercetools (developer preview)
  • AboutYou Cloud
  • Shopify
  • Salesforce Commerce Cloud

You can learn more about Vue Storefront Next from the README on the next branch and this video

If you want to learn more about Vue Storefront Next, contribute or build an integration reach to Filip Rakowski on our Slack

About Vue Storefront 1.x

Important note to developers: From 1.0RC we started using develop branch for nightly builds (contains all new features) and master branch for stable. Please make sure you're working on right branch. Please take a look at Contributing guidelines.

If you're new and need some guidance feel free to visit out forum or reach to from the core team on our Slack

Want to invest some time in building the future of eCommerce? we are looking for agencies and developers willing to help us make VS even more awesome. Interested - contact @Filip Rakowski on slack

We are looking for Contributors and Designer willing to help us in the solution development.

Read contribution rules before making any pull request. Pull request that doesn't meet these requirements will not be merged

PS: Check Storefront UI - our UI library for eCommerce.

See it in action

B2C Theme demo Try out our open demo and if you like it first give us some star on Github β˜… and then contact us on Slack or via [email protected]

This demo site is connected to Magento 2.2 with shopping carts and users synchronization so You can make an order (which unfortunately won't be shipped ;P).

If You like to see Magento 1 integration demo please do contact us.

πŸ†• Capybara Theme

Starting new project on Vue Storefront? Try out the new Capybara Theme. Based on StorefrontUI Design System

B2C Theme demo Try out our open demo and if you like it first give us some star on Github β˜… and then contact us on Vue Storefront Official Slack or via [email protected]

This demo site is connected to Magento2.

Be up to date with the news

We're trying to be very open regarding our development plans, news, roadmap and in general: sharing a lot. Please do bookmark our Official blog to be always up to date!

Foundations | Vue Storefront 1.x

See how it works!

How to install Vue Storefront on Windows?

Demo and the architecture of Vue Storefront

Is it production ready?

Yes! There are more than 140 implementations happening right now and many live shops (check awesome live projects on Vue Storefront).

Browser Compatibility

  • last 2 Chrome versions
  • last 2 Firefox versions
  • last 2 Edge versions
  • modern browsers

For an up-to-date list of supported browsers please see "browserslist" in package.json

Join the community on Slack

If you have any questions or ideas feel free to join our slack via invitation link: https://slack.vuestorefront.io/

Roadmap

Here you can find the accepted roadmap for current milestone and what you can expect with next release.

Roadmap planning

Here you can vote for feature requests and see which ones were accepted. The most upvoted ones will be added to the next milestones. You can also join the slack channel #roadmap-planning where we discuss the next milestones.

The process of adding new features to the roadmap looks like this:

  1. You create an issue and label it as feature request.
  2. One of VS Core team verifies the feature request and if the explanation is clear, it is added to the Roadmap project so it's visible in the board.
  3. Now people can vote for this feature to be added into next milestone with thumb up emoji.
  4. Feature requests with the biggest popularity will be added into next milestones.

We are planning 1-2 milestones ahead. Our milestones are based on requirements from community, partners and production implementations.

Please note that bugfixes are treated separately and in most cases added to the milestones immediately.

Check the feature list of 1.0.

If youd like to take part in roadmap planning feel free to join #roadmap-planning channel on our slack

Documentation + table of contents

The documentation is always THE HARDEST PART of each open source project! But we're trying hard.

Please find out what we've already managed to prepare: available on Github Pages. Please note that new docs are still Work In Progress and will be successfully updated. You can find them also under the docs folder.

You can find some tutorials and explanations on our YouTube channel

Installation

Cookbooks

Awesome projects on Vue Storefront

Check Vue Storefront Live Projects

Vue Storefront Live Projects

The business challenges

Vue Storefront was created to solve a set of key business challenges from the world of the shopping experience. Our goal for the application is to provide the solution with:

  • The ultrafast front-end for the store - with the PWA approach we can now render the catalog of products within milliseconds;
  • The endurance for traffic overloads on the store;
  • The off-line shopping capabilities;
  • The smooth shopping experience close to the user experience from the native mobile applications;
  • The all-in-one front-end for desktop and mobile screens with no necessity for maintaining 3 or more applications for different touchpoints (web browser, Android, iOS etc.).
  • Rapid development without architecture limitations.

The technology

Vue Storefront was built as an all-in-one front-end for eCommerce. For providing the best performance we decided to use Vue.js as a front-end library, Node.js + Express (and maybe GraphQL support) as a server-API, Elastic Search as a database of products and full PWA/off-line support. Here you can read more about the proof of concept for Vue Storefront connected with Magento2.

Besides a big improvement for the shopping experience, we also want to create a great code base for every developer who needs to work on a front-end application for the eCommerce.

The headless architecture

Vue Storefront - Headless Architecture

Design

Vue Storefront supports by default two different themes:

  1. Capybara Theme based on Storefront UI
Vue Storefront - Capybara Theme
  1. Classic/Default

The application is prepared to be fully customized in design through the theming system. With the current version we work on raw, basic template of typical eCommerce for a fashion industry. In the project we used Material Icons.

Vue Storefront - Annimations in sidebar menu

Here you can read more about the process of designing PWA for eCommerce.

The design is available in open source in the Figma file format under the URL https://www.figma.com/file/VKyqbHFI55TKIKcQlFLiVpVF/Vue-Storefront-Open-Source.

Concerns when hosting

When hosting NodeJS applications there are some differences compared to, for example, hosting PHP or Java applications. Server Side Rendering via NodeJS can have memory leaks because of suboptimal code. Although core code is optimized, project specific features or misaligned hosting configuration can introduce this. More on how to avoid these for VueJS can be ready in this article. We also recommend reading about VueJS best practices.

On the server we advice to run PM2 which offers features to keep your NodeJS application stable. When hosting on Kubernetes the checks and memory limits can be leveraged to kill unhealthy containers. More on hosting can be found in the documentation.

Other platforms

Vue Storefront is platform agnostic which means it can be connected to virtually any CMS. Please take a look at Pimcore bridge to give you an idea of how other platforms can be connected. Any support for integrating Prestashop, Shopify ... - much appreciated.

Contributing

If you like the idea behind Vue Storefront and want to become a contributor - do not hesitate and check our list of the active issues or contact us directly via [email protected].

If you have discovered a 🐜 or have a feature suggestion, feel free to create an issue on Github.

Workshops

If you like our project and would like to learn more on how to create Progressive Web Apps you can ask us for a dedicated workshop at your office! Conducted by Vue Storefront core contributors! All the profits are used for supporting Vue Storefront development. Learn more

Support us!

Vue Storefront is and always will be Open Source, released under MIT Licence.

Most of the core team members, VS contributors and contributors in the ecosystem do this open source work in their free time. If you use Vue Storefront for a serious task, and you'd like us to invest more time on it, you can donate the project! You can support us in various ways:

  • Contribute - this is how the Core Team is supporting the project!
  • Evangelize - tweet about us, take some speaking slot at tech conference etc.
  • Sponsor - if you're doing serious business on VS maybe You would like to donate the project and put your logo in here?

This is how we will use the donations:

  • Allow the core team to work on VS
  • Thank contributors if they invested a large amount of time in contributing
  • Support projects in the ecosystem that are of great value for users
  • Infrastructure cost
  • Fees for money handling

If you would like to support us please just let us know: [email protected]

Partners

Vue Storefront is a Community effort brought to You by our great Core Team and supported by the following companies.

See Vue Storefront partners directory

enter image description here

Partners are encouraged to support the project in various ways - mostly by contributing the source code, marketing activities, evangelizing and of course - implementing the production projects. We do support our partners by dedicated contact channels, workshops and by sharing the leads from merchants interested in implementations.

If you like to become our Partner just let us know via [email protected].

The screenshots

Vue Storefront - Annimations in the sidebar cart

The license

Vue Storefront source code is completely free and released under the MIT License.

analytics


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (65,637)Β 
typescript (8,923)Β 
vue (3,645)Β 
open-source (657)Β 
frontend (448)Β 
mobile (444)Β 
pwa (286)Β 
nuxt (193)Β 
ecommerce (185)Β 
magento (97)Β 
headless (82)Β 
magento2 (77)Β 
e-commerce (70)Β 
shopify (43)Β 
vue3 (29)Β 
storefront (20)Β 

Find Open Source By Browsing 7,000 Topics Across 59 Categories