This is a backend service for vue-storefront. Provides data access to product catalog (via ElasticSearch) and allows users to place orders into order queue (by default it's Redis queue supported via kqueue library).
Vue Storefront is a standalone PWA (Progressive Web Application ) storefront for your eCommerce, possible to connect with any eCommerce backend (eg. Magento, 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 still in the prove of concept phase. We are looking for Contributors and Designer willing to help us the the solution development.
Vue Storefront was build as a 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.
- Docker and Docker Compose
Already included in vue-storefront-api Docker image (required locally, if you do not use containerization):
- Node.js 8.x or higher
- Yarn
- ImageMagick (to fit, resize and crop images)
Start a containerized environment
The legacy (A) mode - starting just the Elastic and Redis containers:
docker-compose up -d
The standard (B) mode - starting Elastic, Redis + Vue Storefront API containers:
docker-compose -f docker-compose.yml -f docker-compose.nodejs.yml up -d
As a result, all necessary services will be launched:
- Vue Storefront API runtime environment (Node.js with dependencies from
package.json) - ElasticSearch
- Redis
- Kibana (optional)
Then, to update the structures in the database to the latest version (data migrations), do the following:
- (A)
docker exec -it vuestorefrontapi_app_1 yarn migrate - (B)
yarn migrate
By default, the application server is started in development mode. It means that code auto reload is enabled along with ESLint, babel support.
Import product catalog
Product catalog is imported using elasticdump, which is installed automatically via project dependency. The default ElasticSearch index name is: vue_storefront_catalog
- (A)
yarn restore - (B)
docker exec -it vuestorefrontapi_app_1 yarn restore
It restores JSON documents stored in ./var/catalog.json. The opposite command - used to generate catalog.json file from running ElasticSearch cluster:
- (A)
yarn dump - (B)
docker exec -it vuestorefrontapi_app_1 yarn dump
Access ElasticSearch data with Kibana
A Kibana service is available to explore, search and visualize indexed data at the following url:
http://localhost:5601/
At first access it will ask to specify an index pattern, insert vue_storefront*
Catalog API calls are compliant with ElasticSearch (it works like a filtering proxy to ES). More on ES queries: ElasticSearch queries tutorial
Elastic search endpoint: http://localhost:8080/api/catalog/search/<INDEX_NAME>/. You can run the following command to check if everything is up and runing (it assumes vue_storefront_catalog as default index name):
curl -i http://elastic:changeme@localhost:8080/api/search/vue_storefront_catalog/_search?query=*
This backend is using ElasticSearch data formats popularized by ElasticSuite for Magento2 by Smile.fr.
Please use data migration mechanism provided to manipulate Redis, ElasticSearch or kue. Details: https://github.com/DivanteLtd/vue-storefront-api/tree/master/doc
When adding custom Extensions to the API you might want to define some dependencies inside them. Thanks to Yarn workspaces dependecies defined inside your custom module will be intaled when you execute yarn at project root level, so it's way esier and faster than installing all modules dependcies separetly.
To do this, define the package.json with your dependencies in your custom module:
src/api/extensions/{your-custom-extension}/package.jsonsrc/platforms/{your-custom-platform}/package.json
Executing docker exec -it vuestorefrontapi_app_1 yarn install will also download your custom modules dependencies.
NOTE: npm users will still have to install the dependencies individually in their modules.