Merge pull request #105 from OraOpenSource/2.1.1

2.1.1

ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+### Issue Description
+[Explain]
+
+### APEX Front-End Boost Version
+[Example: v2.1.1]
+
+### Operating System
+[Example: Windows]
+
+### Node Version
+[Example: v4.4.5]
+
+### Browser
+[Example: Chrome v50]
+
+### APEX Version
+[Example: v5.0.3]
+
+### Web Server
+[Example: ORDS 3.0.3, Tomcat 7]
+
+### Your `config.json` file
+[Paste code]

README.md

@@ -3,13 +3,33 @@
 [![Build Status](https://travis-ci.org/OraOpenSource/apex-frontend-boost.svg?branch=master)](https://travis-ci.org/OraOpenSource/apex-frontend-boost)
 [![Dependency Status](https://david-dm.org/OraOpenSource/apex-frontend-boost.svg)](https://david-dm.org/OraOpenSource/apex-frontend-boost)
 
-APEX Front-End Boost makes coding faster, easier, and prettier. This productivity tool helps you work with static files (`js`, `css`, `images`, etc.) more efficiently within an APEX application.
-
+- [What APEX Front-End Boost is](#what-apex-front-end-boost-is)
+	- [What APEX Front-End Boost does](#what-apex-front-end-boost-does)
+	- [How APEX Front-End Boost helps you](#how-apex-front-end-boost-helps-you)
+	- [Other benefits](#other-benefits)
+- [Project Sponsors](#project-sponsors)
+- [System Requirements](#system-requirements)
+- [Install](#install)
+	- [via Git](#via-git)
+	- [via npm](#via-npm)
+- [Upgrade](#upgrade)
+	- [via Git](#via-git)
+	- [via npm](#via-npm)
+- [Configuration](#configuration)
+- [APEX Application Setup](#apex-application-setup)
+- [Run](#run)
+- [Usage](#usage)
+- [Features](#features)
+- [Changelog](#changelog)
+
+## What APEX Front-End Boost is
 APEX Front-End Boost is a personal local web server that hosts and distributes your files to your APEX application.
 
+APEX Front-End Boost makes coding faster, easier, and prettier. This productivity tool helps you work with static files (`js`, `css`, `images`, etc.) more efficiently within an APEX application.
+
 ![demo](/media/demo-main.gif)
 
-## What APEX Front-End Boost does
+#### What APEX Front-End Boost does
 - Minifies `js` and `css`.
 - Generates  `js` and `css` sourcemaps.
 - Adds `css` vendor prefixes.
@@ -18,15 +38,17 @@ APEX Front-End Boost is a personal local web server that hosts and distributes y
 - Generates APEX Theme Roller configuration. *(optional)*
 - Transforms `css` to RTL format. *(optional)*
 - Adds a standardized header comment block to `js` and `css` files. *(optional)*
+- Minifies images seamlessly *(optional)*
 
-## How APEX Front-End Boost helps you
+#### How APEX Front-End Boost helps you
 - Cut down on front-end development time.
 - Enhance your application performance due to smaller file sizes.
 - Keep coding in your favorite code editor, without having to constantly upload anything to APEX or a web server.
 - Stop manual refresh of your browser to get `js` and `css` modification.
 - Stop affecting other developers. **Any development done within APEX Front-End Boost affects you and only you**.
 - Be notified of `js` and `css` errors as you save.
 
+#### Other benefits
 It makes responsive development easier by synchronizing multiple devices together. Your desktop, tablet and mobile device will imitate each others actions (scrolling, clicking, typing) as long as you've got APEX Front-End Boost running.
 
 It eliminates the need for refreshing the browser. As soon as you save your code in the text editor, you get automatic code injection / reloading in the browser.
@@ -39,16 +61,46 @@ Thanks to [Insum Solutions](http://insum.ca/) for sponsoring this project.
 - [Oracle APEX](https://apex.oracle.com) 5 (or more) for [Application Setup Option 1](/docs/apex-setup.md)
 - [Oracle APEX](https://apex.oracle.com) 4-5 (or more) for [Application Setup Option 2](/docs/apex-setup.md)
 
+*Having `Cross Origin Sharing Requests` issues? [See CORS documentation](/docs/cors.md).*
+
 ## Install
-On the command line:
+- Open the command line
+- Go to the APEX Front-End Boost directory
+
+#### via Git
+```bash
+git clone https://github.com/OraOpenSource/apex-frontend-boost.git
+cd apex-frontend-boost		
+npm install
+```
+
+#### via npm
 ```bash
 npm install apex-frontend-boost
 ```
 
+*Note: installing via npm automatically creates a `\node_modules\` directory and installs APEX Front-End Boost within. Please use only if you understand what that entails, otherwise use the Git method.*
+
 *Having problems installing on Windows? [See documentation](/docs/windows.md).*  
 
 *Having problems installing on Linux? [See documentation](/docs/linux.md).*
 
+## Upgrade
+- Open the command line
+- Go to your APEX Front-End Boost directory
+
+#### via Git
+```bash
+git fetch origin
+git reset --hard origin/master
+npm install
+```
+
+#### via npm
+```bash
+npm install apex-frontend-boost
+```
+
 ## Configuration
 You need to configure APEX Front-End Boost for your project(s). [See documentation](/docs/config.json.md).
 
@@ -65,16 +117,21 @@ There are two options to setup your application:
 Review the [APEX Setup](/docs/apex-setup.md) docs to choose the most appropriate option for your project.
 
 ## Run
-`npm start -- --project=yourProjectName`
+**On the command line:**  
+```bash
+npm start -- --project=yourProjectName
+```
 
-**Running on Windows?**
+**or use Windows shortcut:**
 - Launch `apex-frontend-boost.bat`
 - Enter project name
 
-**Running on Linux/OSx?**
+**or use Linux/OS X shortcut:**
 - Execute `./apex-frontend-boost.sh`
 - Enter project name
 
+*Note: If you encounter errors while executing the steps above, you may need to use an elevated command line (run as administrator).*
+
 ## Usage
 From the `src` folder you can create, edit or delete any files in:
 ```
@@ -96,8 +153,7 @@ APEX Front-End Boost will automatically compile your files to this folder struct
     |-lib
 ```
 
-### Self-Signed SSL Browser Warning
-[See documentation](/docs/ssl-warning.md).
+*Having problems regarding Self-Signed SSL Browser Warning? [See documentation](/docs/ssl-warning.md).*
 
 ## Features
 - [Browsersync](http://www.browsersync.io/)
@@ -109,6 +165,7 @@ APEX Front-End Boost will automatically compile your files to this folder struct
 - [Sourcemaps](https://www.npmjs.com/package/gulp-sourcemaps)
 - [Header](https://github.com/tracker1/gulp-header)
 - [RTLCSS](https://github.com/MohammadYounes/rtlcss)
+- [imagemin](https://github.com/sindresorhus/gulp-imagemin)
 - More...
 
 [See features examples](/docs/examples.md).

changelog.md

@@ -1,4 +1,15 @@
 # Changelog
+## 2.1.1
+- Greatly enhanced the project error handling to provide more details and hints to the user.
+- The `/src/` folder is now automatically created if it doesn't exist yet.
+- Added `.sass` file support in addition to the existing `.scss` support.
+- Docs: Added a documentation notice on ORDS issues.
+- Docs: Added an advice to use an elevated command line (run as admin).
+- Docs: Changed some of the project terminology.
+- Docs: Provided two different installation options (Git and npm).
+- Docs: Enhanced the documentation for `config.json`
+- Created project issue template for better support going forward.
+
 ## 2.1.0
 - Project is now available on npm
 - Fixed a bug preventing from doing POST on Chrome

default.json

@@ -2,10 +2,6 @@
     "appURL": "",
     "srcFolder": "src",
     "distFolder": "dist",
-    "header": {
-        "enabled": false,
-        "packageJsonPath": ""
-    },
     "jsConcat": {
         "enabled": false,
         "finalName": "app"
@@ -34,7 +30,14 @@
         "finalName": "themeroller",
         "files" : []
     },
+    "header": {
+        "enabled": false,
+        "packageJsonPath": ""
+    },
     "rtl": {
         "enabled": false
+    },
+    "imageOptimization": {
+       "enabled": false
     }
 }