Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
b183b3d
Scaffolded vuepress docs structure
NataliaTepluhina Sep 12, 2018
1cfbeb7
* added favicon
NataliaTepluhina Sep 12, 2018
8f14f1e
Main structure done
NataliaTepluhina Sep 12, 2018
e673f1f
* scaffolded introduction
NataliaTepluhina Sep 12, 2018
3890129
Started reworking installation section
NataliaTepluhina Sep 13, 2018
1e7e72b
* finished 'User-Friendly installation'
NataliaTepluhina Sep 14, 2018
c61a973
* checked and fixed standard mode of manual API installation
NataliaTepluhina Sep 15, 2018
e3c1491
Vue-storefront Linux&Mac manual installation tested and finished
NataliaTepluhina Sep 15, 2018
5410c63
* checked and styled Windows installation instructions
NataliaTepluhina Sep 15, 2018
c7ffc50
Added initial version of Magento 2 integration section
NataliaTepluhina Sep 17, 2018
b288d2e
Added production setup instructions and couple of fixes
NataliaTepluhina Sep 17, 2018
bd1b855
* started working on configuration file
NataliaTepluhina Sep 18, 2018
4836678
* implemented @allozaur PR changes to Magento integration
NataliaTepluhina Sep 19, 2018
49926b4
* working on config file
NataliaTepluhina Sep 20, 2018
db244e9
* moved vuepress docs to separate package inside the monorepo
NataliaTepluhina Sep 22, 2018
4227434
Fix images paths and finished config file draft
NataliaTepluhina Sep 22, 2018
28be332
Finished configuration file article draft
NataliaTepluhina Sep 23, 2018
016a65a
Merge branch 'develop' into feature/vuepress-docs
NataliaTepluhina Sep 24, 2018
886a32f
Add basics/project-structure and scaffolded all related links
NataliaTepluhina Sep 24, 2018
7642a99
Merge branch 'feature/vuepress-docs' of github.com:NataliaTepluhina/v…
NataliaTepluhina Sep 24, 2018
d364065
Finish contributing chapter
NataliaTepluhina Sep 24, 2018
5b8c936
Add Vue Storefront modules chapter
NataliaTepluhina Sep 25, 2018
3668d21
Add deployment script and fix image paths
NataliaTepluhina Sep 25, 2018
2458163
Merge branch 'develop' of github.com:DivanteLtd/vue-storefront into f…
NataliaTepluhina Sep 25, 2018
286b234
Fixed default.json
NataliaTepluhina Sep 25, 2018
da90869
Add feature list and some headings fixes
NataliaTepluhina Sep 25, 2018
645d49e
Reformat default.json
NataliaTepluhina Sep 25, 2018
09be06d
Added missing fields to config file explained chapter
NataliaTepluhina Sep 26, 2018
d094558
Fix links;
NataliaTepluhina Sep 26, 2018
133b532
Merge branch 'develop' into feature/vuepress-docs
pkarw Oct 4, 2018
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions deploy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
set -e

cd docs

npm run docs:build

cd .vuepress/dist

git init
git add -A
git commit -m 'deploy'

# if you are deploying to https://<USERNAME>.github.io
# git push -f git@github.com:vuevixens/vuevixens.github.io.git master

# if you are deploying to https://<USERNAME>.github.io/<REPO>
git push -f git@github.com:NataliaTepluhina/vue-storefront.git master:gh-pages

cd -
82 changes: 82 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
module.exports = {
base: '/vue-storefront/',
head: [['link', { rel: 'icon', href: '/favicon.png' }]],
themeConfig: {
repo: 'DivanteLtd/vue-storefront',
docsDir: 'docs',
editLinks: true,
nav: [
{
text: 'YouTube',
link: 'https://www.youtube.com/channel/UCkm1F3Cglty3CE1QwKQUhhg',
},
{
text: 'Medium',
link: 'https://medium.com/the-vue-storefront-journal',
},
],
sidebar: {
'/guide/': [
'',
{
title: 'Installation',
collapsable: false,
children: [
'installation/linux-mac',
'installation/windows',
'installation/magento',
'installation/production-setup',
],
},
{
title: 'Basics',
collapsable: false,
children: [
'basics/project-structure',
'basics/configuration',
'basics/contributing',
'basics/modules',
'basics/feature-list',
'basics/recipes',
'basics/typescript',
],
},
// {
// title: 'Vue Storefront core and themes',
// collapsable: false,
// children: [
// 'core-themes/themes',
// 'core-themes/webpack',
// 'core-themes/core-components',
// 'core-themes/plugins',
// 'core-themes/vuex',
// 'core-themes/data',
// 'core-themes/extensions',
// ],
// },
// {
// title: 'Data in Vue Storefront',
// collapsable: false,
// children: ['data/data'],
// },
// {
// title: 'Working with extensions',
// collapsable: false,
// children: ['extensions/'],
// },
// {
// title: 'Integrations',
// collapsable: false,
// children: ['integrations/magento', 'integrations/multistore'],
// },
// {
// title: 'Core API Modules docs',
// collapsable: false,
// children: ['api-modules/cart-module'],
// },
],
},
},
title: 'Vue Storefront',
description: 'Headless PWA for eCommerce',
};
Binary file added docs/.vuepress/public/Apple_iPhone_X.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/magento_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/magento_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/magento_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/storefront.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/video-webcast-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/vs-video.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
home: true
heroImage: /logo.png
actionText: Get Started →
actionLink: /guide/
---
48 changes: 48 additions & 0 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# About

<a href="https://travis-ci.org/DivanteLtd/vue-storefront"><img src="https://travis-ci.org/DivanteLtd/vue-storefront.svg?branch=master" alt="build:passed"></a>
![version](https://img.shields.io/badge/node-v8.x-blue.svg)
![Branch stable](https://img.shields.io/badge/stable%20branch-master-blue.svg)
![Branch Develop](https://img.shields.io/badge/dev%20branch-develop-blue.svg)
<a href="https://join.slack.com/t/vuestorefront/shared_invite/enQtMzA4MTM2NTE5NjM2LTI1M2RmOWIyOTk0MzFlMDU3YzJlYzcyYzNiNjUyZWJiMTZjZjc3MjRlYmE5ZWQ1YWRhNTQyM2ZjN2ZkMzZlNTg">![Branch Develop](https://img.shields.io/badge/community%20chat-slack-FF1493.svg)</a>

Vue Storefront is a standalone PWA storefront for your eCommerce, possible to connect with any eCommerce backend (eg. Magento, <a href="https://github.com/DivanteLtd/pimcore2vuestorefront">Pimcore</a>, 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.

## Video demo

<p style="text-align: center;">
<a href="https://www.youtube.com/watch?v=L4K-mq9JoaQ" target="_blank">
<img :src="$withBase('/vs-video.png')" alt="See how it works">
</a>
</p>

## Technical Webcast #1 - demo and the architecture

<p style="text-align: center;">
<a href="https://www.youtube.com/watch?v=sRSmEP4jva0&feature=youtu.be" target="_blank">
<img :src="$withBase('/video-webcast-1.png')" alt="Demo and the architecture of Vue Storefront">
</a>
</p>

- [Read on how to integrate it with Magento2](https://medium.com/@piotrkarwatka/vue-storefront-how-to-install-and-integrate-with-magento2-227767dd65b2),
- [Read how to create Vue Storefront theme](https://medium.com/@frakowski/developing-themes-in-vue-storefront-backend-agnostic-ecommerce-pwa-frontend-part-1-72ea3c939593),
- [Read the interviews with authors of first production deployments](https://medium.com/@piotrkarwatka/vue-storefront-on-production-interview-with-gogetgold-com-developers-71e4b48ef996)

## Is it production ready?

Yes! There are more than 10 implementations happening right now and one live shop.

## 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](https://join.slack.com/t/vuestorefront/shared_invite/enQtMzA4MTM2NTE5NjM2LTI1M2RmOWIyOTk0MzFlMDU3YzJlYzcyYzNiNjUyZWJiMTZjZjc3MjRlYmE5ZWQ1YWRhNTQyM2ZjN2ZkMzZlNTg)

## Roadmap

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

[See the roadmap](https://github.com/DivanteLtd/vue-storefront/milestones).

[Check the feature list of 1.0](../basics/feature-list.md).
3 changes: 3 additions & 0 deletions docs/guide/api-modules/cart-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Core API Modules docs

_Work in progress_
Loading