Merge pull request #67 from DivanteLtd/develop

docker support

Author: pkarw

.env

@@ -0,0 +1 @@
+COMPOSE_PROJECT_NAME=vue-storefront-api

README.md

@@ -16,33 +16,47 @@ Besides a big improvement for the shopping experience, we also want to create a
 
 ## Requirements
 
-- Node.js 8.x or higher
 - 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](https://www.imagemagick.org/script/index.php) (to fit, resize and crop images)
 
 ## Installation
 
-**Warm up [ElasticSearch](https://www.elastic.co/products/elasticsearch) Cluster and [Redis](https://redis.io/)**
+**Start a containerized environment**
 
+The **legacy** (A) mode - starting just the Elastic and Redis containers:
 `docker-compose up -d`
 
-`npm run migrate` to execute all data migrations up to date
+The **standard** (B) mode - starting Elastic, Redis + Vue Storefront API containers:
+`docker-compose -f docker-compose.yml -f docker-compose.nodejs.yml up -d`
 
-**Import product catalog**
+As a result, all necessary services will be launched:
+- Vue Storefront API runtime environment (Node.js with dependencies from `package.json`)
+- [ElasticSearch](https://www.elastic.co/products/elasticsearch)
+- [Redis](https://redis.io/)
+- Kibana (optional)
 
-Product catalog is imported using [elasticdump](https://www.npmjs.com/package/elasticdump), which is installed automatically via project dependency. The default ElasticSearch index name is: `vue_storefront_catalog`
+Then, to update the structures in the database to the latest version (data migrations), do the following:
 
-`npm run restore`
+(A) `docker exec -it vuestorefrontapi_app_1 yarn migrate`
+(B) `yarn migrate`
 
-It restores JSON documents stored in `./var/catalog.json`. The opposite command - used to generate `catalog.json` file from running ElasticSearch cluster:
+By default, the application server is started in development mode. It means that code auto reload is enabled along with ESLint, babel support.
 
-`npm run dump`
+**Import product catalog**
 
-**Run development server**
+Product catalog is imported using [elasticdump](https://www.npmjs.com/package/elasticdump), which is installed automatically via project dependency. The default ElasticSearch index name is: `vue_storefront_catalog`
 
-Code auto reload is enabled along with ESLint, babel support.
+(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:
 
-`PORT=8080 npm run dev`
+(A) `yarn dump`
+(B) `docker exec -it vuestorefrontapi_app_1 yarn dump`
 
 **Access ElasticSearch data with Kibana**
 
@@ -57,7 +71,7 @@ Catalog API calls are compliant with ElasticSearch (it works like a filtering pr
 
 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://localhost:8080/api/search/vue_storefront_catalog/_search?query=*`
+`curl -i http://elastic:changeme@localhost:8080/api/search/vue_storefront_catalog/_search?query=*`
 
 ## Data formats
 This backend is using ElasticSearch data formats popularized by [ElasticSuite for Magento2 by Smile.fr](https://github.com/Smile-SA/elasticsuite).
@@ -75,7 +89,7 @@ To do this, define the `package.json` with your dependencies in your custom modu
 - `src/api/extensions/{your-custom-extension}/package.json` 
 - `src/platforms/{your-custom-platform}/package.json`
 
-Executing `yarn` at root level will also download your custom modules dependencies.
+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.
 

config/custom-environment-variables.json

@@ -0,0 +1,14 @@
+{
+  "server": {
+    "host": "BIND_HOST",
+    "port": "BIND_PORT"
+  },
+  "elasticsearch": {
+    "host": "ELASTICSEARCH_HOST",
+    "port": "ELASTICSEARCH_PORT"
+  },
+  "redis": {
+    "host": "REDIS_HOST",
+    "port": "REDIS_PORT"
+  }
+}