Vue Storefront - PWA for eCommerce. 100% offline, platform agnostic, headless, Magento 2 supported. Always Open Source, MIT license. Join us as contributor (contributors@vuestorefront.io).
Switch branches/tags
@vue-storefront/theme-starter@1.3.0 @vue-storefront/theme-starter@1.3.0-alpha.2 @vue-storefront/theme-starter@1.3.0-alpha.1 @vue-storefront/theme-starter@1.2.0 @vue-storefront/theme-starter@1.0.0 @vue-storefront/theme-starter@1.0.0-rc.3 @vue-storefront/theme-default@1.3.0 @vue-storefront/theme-default@1.3.0-alpha.2 @vue-storefront/theme-default@1.3.0-alpha.1 @vue-storefront/theme-default@1.2.0 @vue-storefront/theme-default@1.1.0 @vue-storefront/theme-default@1.0.0 @vue-storefront/theme-default@1.0.0-rc.3 @vue-storefront/theme-catalog@1.0.0-rc.3 @vue-storefront/store@1.3.0 @vue-storefront/store@1.3.0-alpha.2 @vue-storefront/store@1.3.0-alpha.1 @vue-storefront/store@1.2.0 @vue-storefront/store@1.1.0 @vue-storefront/store@1.0.5 @vue-storefront/store@1.0.0 @vue-storefront/store@1.0.0-rc.3 @vue-storefront/i18n@1.3.0 @vue-storefront/i18n@1.3.0-alpha.2 @vue-storefront/i18n@1.3.0-alpha.1 @vue-storefront/extension-template@1.3.0 @vue-storefront/extension-template@1.3.0-alpha.2 @vue-storefront/extension-template@1.3.0-alpha.1 @vue-storefront/extension-template@1.0.0 @vue-storefront/extension-template@1.0.0-rc.3 @vue-storefront/extension-payment-cash-on-delivery@1.3.0 @vue-storefront/extension-payment-cash-on-delivery@1.3.0-alpha.2 @vue-storefront/extension-payment-cash-on-delivery@1.3.0-alpha.1 @vue-storefront/extension-payment-cash-on-delivery@1.0.0 @vue-storefront/extension-payment-cash-on-delivery@1.0.0-rc.3 @vue-storefront/extension-payment-backend-methods@1.3.0 @vue-storefront/extension-payment-backend-methods@1.3.0-alpha.2 @vue-storefront/extension-payment-backend-methods@1.3.0-alpha.1 @vue-storefront/extension-payment-backend-methods@1.0.0 @vue-storefront/extension-payment-backend-methods@1.0.0-rc.3 @vue-storefront/extension-mailchimp-subscribe@1.3.0 @vue-storefront/extension-mailchimp-subscribe@1.3.0-alpha.2 @vue-storefront/extension-mailchimp-subscribe@1.3.0-alpha.1 @vue-storefront/extension-mailchimp-subscribe@1.3.0-alpha @vue-storefront/extension-mailchimp-subscribe@1.0.0 @vue-storefront/extension-mailchimp-subscribe@1.0.0-rc.3 @vue-storefront/extension-magento2-cms@1.3.0 @vue-storefront/extension-magento2-cms@1.3.0-alpha.2 @vue-storefront/extension-magento2-cms@1.3.0-alpha.1 @vue-storefront/extension-magento2-cms@1.3.0-alpha.0 @vue-storefront/extension-google-analytics@1.3.0 @vue-storefront/extension-google-analytics@1.3.0-alpha.2 @vue-storefront/extension-google-analytics@1.3.0-alpha.1 @vue-storefront/extension-google-analytics@1.3.0-alpha.0 @vue-storefront/extension-google-analytics@1.0.0 @vue-storefront/extension-google-analytics@1.0.0-rc.3 @vue-storefront/extension-droppoint-shipping@1.0.5 @vue-storefront/extension-droppoint-shipping@1.0.0 @vue-storefront/extension-droppoint-shipping@1.0.0-rc.3 @vue-storefront/core@1.3.1 @vue-storefront/core@1.3.1-alpha.2 @vue-storefront/core@1.3.1-alpha.1 @vue-storefront/core@1.3.1-alpha @vue-storefront/core@1.3.0 v1.4.5 v1.4.4 v1.4.3 v1.4.0 v1.3.1 v1.3.0 v1.3.0-alpha.2 v1.3.0-alpha.1 v1.3.0-alpha.0 v1.2.0 v1.1.0 v1.0.5 v1.0.4 v1.0.3 v1.0.2 v1.0.1 v1.0.0 v1.0.0-rc.3 v1.0.0-rc.2 v1.0.0-rc.0 v0.4.0 v0.3.0 v0.2.1-alpha.0 v0.2.0-alpha.0 cms@1.2.0
Nothing to show
Clone or download
Latest commit 08ab053 Oct 18, 2018
Permalink
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Oct 2, 2018
config Final touch on config filtering Oct 3, 2018
core Force SSR disable for my-account and checkout pages Oct 10, 2018
doc Update about-modules.md Oct 18, 2018
docker/vue-storefront PM2 mode fix (--no-daemon only in Docker environment) Jun 21, 2018
docs Docs deployment script Oct 4, 2018
kubernetes Kubernetes - initial commit Aug 7, 2018
src Hotfix: webpack templates cleanup Oct 9, 2018
tests CR fixes Sep 26, 2018
.babelrc Fixes @vue-storefront packages being excluded from babel. Closes #1530 Aug 6, 2018
.editorconfig Very initial commit Aug 16, 2017
.env Contenerized environment for the front-end application Jun 14, 2018
.eslintignore refactor api to modules catalog and namespaces Aug 23, 2018
.eslintrc.js Merge branch 'develop' into improvement/arrow_functions Aug 3, 2018
.gitignore git ignore Aug 31, 2018
.jshintrc Add mix-blend-mode to checkout product thumbnails Dec 1, 2017
.node-version #326: add node-version file Dec 21, 2017
.postcssrc autoprefixed added (not working, yay) Jun 11, 2018
.travis.yml feat: change test structure Aug 7, 2018
CHANGELOG.md Changelog update Oct 5, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Oct 24, 2017
CONTRIBUTING.md Fix typo Aug 19, 2018
LICENSE Create LICENSE Sep 26, 2017
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md Oct 18, 2018
README.md Update README.md Oct 13, 2018
cypress.json feat: change test structure Aug 7, 2018
deploy.sh Add deployment script and fix image paths Sep 25, 2018
docker-compose.yml Fix for dulicated shims Oct 8, 2018
ecosystem.json PM2 stability fixes: Sep 2, 2018
jsconfig.json refactor api to modules catalog and namespaces Aug 23, 2018
lerna.json Publish May 18, 2018
package.json Merge branch 'develop' into feature/vuepress-docs Oct 4, 2018
shims.d.ts feat: Typescript migration Aug 9, 2018
tsconfig.json feat: Typescript migration Aug 9, 2018
yarn.lock Added raw output example Sep 27, 2018

README.md

Vue Storefront - headless PWA for eCommerce

build:passed version Branch stable Branch Develop Branch Develop lerna

Vue Storefront is a standalone PWA storefront for your eCommerce, possible to connect with any eCommerce backend (eg. Magento, Pimcore, Prestashop or Shopware) through the API.

Vue Storefront is and always will be in the open source. 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.

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 alook at Contributing guidelines.

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

See the ideas behind Vue Storefront here

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

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 contributors@vuestorefront.io.

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

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

Video demo

See how it works!

Technical Webcast #1 - demo and the architecture

Demo and the architecture of Vue Storefront

Is it production ready?

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

Join the community on Slack

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

Roadmap

We are planning 1-2 milestones ahead. Our milestones are based on requirements from community, partners and production implementations. See the roadmap. Check the feature list of 1.0.

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 under /doc folder: https://github.com/DivanteLtd/vue-storefront/tree/master/doc. There is also new, updated /docs folder with original documentation migrated to VuePress (Work in Progress).

Please try out our NEW DOCS: available on Github Pages. Please note that new docs are still Work In Progress and will be successfully updated.

You can find some tutorials and explainations on our YouTube channel

Installation

Basics

Vue Storefront core and themes

Tutorial series on creating themes for Vue Storefront:

Data in Vue Storefront

Working with Vue Storefront Extensions

Integrations

Core API Modules docs (experimental feature, not safe to use right now)

'Default theme' contribution rules

Awesome projects related to Vue Storefront

Check Vue Storefront Awesome

The business challenges

Vue Storefront was created to solve a set of key business challenges from the world of 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 architecture

Architecture diagram

The design

The application is prepared to be fully customized in design through 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

Vue Storefront - Annimations in featured products box

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.

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 on how other platforms can be connected. Any support for integrating Prestashop, Shopify ... - much appreciated.

The license

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

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 contributors@vuestorefront.io.

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 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: contributors@vuestorefront.io

Partners

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

Divante Snow.dog Wagento Summa Solutions Acid Green
Macopedia Macopedia Magenest ECOMMBITS Optiweb
Bitbull Vendic Get.Noticed Novatize Imagination Media
MageDirect Edmonds Commerce KT Team MageBit UpsideLab
Meigee WebVisum Phoenix Media Viaict Bemeir

Partners are encouraged to support the project by 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 contributors@vuestorefront.io.

The screenshots

Vue Storefront - Annimations in the sidebar cart

Vue Storefront - Annimations on producy card