Skip to content

Commit

Permalink
Feature: 171. Add cli script for automatic installation backend and c…
Browse files Browse the repository at this point in the history
…onfiguring storefront for mac-os and linux
  • Loading branch information
madonzy committed Nov 5, 2017
1 parent a2fb311 commit dc79deb
Show file tree
Hide file tree
Showing 13 changed files with 647 additions and 27 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ npm-debug.log
.vscode/
.idea/
yarn.lock
src/config.js
src/config.json
package-lock.json
var
30 changes: 26 additions & 4 deletions doc/Installing on Linux and MacOS.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,34 @@

## Installation
# Installation

To make vue-storefront up and runing you need to have the latest version of node (v8.3.0 used for development). You'll also need docker - or ElasticSearch + Redis installed on localhost instead. The steps below are tested on MacOS and Linux environments.

If you're on Windows please check [Windows Installation Tutorial](https://github.com/DivanteLtd/vue-storefront/blob/master/doc/Installing%20on%20Windows.md)

Let's go:

## User-friendly installation

If you're MacOS or Linux user now you're able to install with pretty nice CLI installer :)

### Requirements
1. Docker
2. Node.js (with npm package)

### Installing
You need to use https://github.com/DivanteLtd/vue-storefront.

```
git clone https://github.com/DivanteLtd/vue-storefront.git vue-storefront
cd vue-storefront
npm install
npm run install
```

After answering some questions precess would start automatically. Enjoy :)


## Manual installation

### Install the vue-storefront-api
You need to use https://github.com/DivanteLtd/vue-storefront-api.
It's the ultimate API backend for this application
Expand Down Expand Up @@ -64,8 +86,8 @@ npm install
You have to prepare the config:

```
cp src/config.example.js src/config.js
nano config.js
cp src/config.example.json src/config.json
nano config.json
```

And then you can build app and run dev server:
Expand Down
4 changes: 2 additions & 2 deletions doc/Installing on Windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Vue storefront is based on open source technologies which SHOULD (in theory ;))
2. Clone the [vue-storefront](https://github.com/DivanteLtd/vue-storefront) project: `git clone https://github.com/DivanteLtd/vue-storefront.git vue-storefront`
3. Go to vue-storefront in dir: `cd vue-storefront`
4. Install dependencies: `npm install`
5. Copy `src/config.example.js` to `src/config.js`
6. Images: because vue-storefront-api uses `imagemagick` and some nodejs cmdline bindings it can be dificult to run the image proxy on localhost/windows machine. Please point out the vue-storefront to image proxy provided by changing `src/config.js` images.baseUrl:
5. Copy `src/config.example.json` to `src/config.json`
6. Images: because vue-storefront-api uses `imagemagick` and some nodejs cmdline bindings it can be dificult to run the image proxy on localhost/windows machine. Please point out the vue-storefront to image proxy provided by changing `src/config.json` images.baseUrl:

```json
export default {
Expand Down
Loading

0 comments on commit dc79deb

Please sign in to comment.