Webpack: development and production environments

Author: avivace

README.md

@@ -20,9 +20,9 @@ npm install
 npm run dev
 ```
 
-By default, the build configuration assumes you have the backend available at `localhost:5000`. Change the `CB_ENDPOINT` value according to your setup (e.g. different location, production, static ip of a real RPi running the backend) in the `config/dev.eng.js` file.
+By default, the (development) build configuration assumes you have the backend available at `localhost:5000`. Change the `CB_ENDPOINT` value according to your setup (e.g. different location, production, static ip of a real RPi running the backend) in the `config/dev.env.js` file.
 
-To serve in production, change `CB_ENDPOINT` to `'""'` and
+While in production environment, it assumes you are serving the vue app from the backend, thus having `CB_ENDPOINT` to a blank string.
 
 ```bash
 # build the web application
@@ -31,7 +31,7 @@ npm run build
 mv dist ../coderbot/
 ```
 
-At this point, the Flask backend serves the built application at `/vue`.
+At this point, run the backend and Flask will serve the built Vue app at `/vue`.
 
 Another build value you may want to edit it's `assetsPublicPath` in `config/index.js`, which allows to serve the application from a subfolder.
 

config/dev.env.js

@@ -2,14 +2,13 @@
 const merge = require('webpack-merge')
 const prodEnv = require('./prod.env')
 
-// Beware, changes in this files require a new build. 
+// Beware, changes in this files require a new build.
 //  I.e. `npm run dev` is not aware of changes made here.
 
 module.exports = merge(prodEnv, {
   NODE_ENV: '"development"',
   // Backend location. Must point to the exposed Flask instance
   //  By default, if you run the backend locally, it's available at localhost:5000
-  //  If you run the Vue app in production, served by the Flask backend, it should be '""'
   CB_ENDPOINT: '"http://localhost:5000"',
   // Legacy APIs
   APIv1: '""',

config/prod.env.js

@@ -1,4 +1,10 @@
 'use strict'
 module.exports = {
-  NODE_ENV: '"production"'
+  NODE_ENV: '"production"',
+  // Backend location. Must point to the exposed Flask instance
+  CB_ENDPOINT: '""',
+  // Legacy APIs
+  APIv1: '""',
+  // New API, exposed by Connexion
+  APIv2: '"/v2"'
 }