Skip to content

Commit

Permalink
more doc enhancements
Browse files Browse the repository at this point in the history
fixes #104
  • Loading branch information
vincentmorneau committed Jun 21, 2016
1 parent 3764af7 commit 4fd7188
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 10 deletions.
52 changes: 45 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -20,14 +40,15 @@ APEX Front-End Boost is a personal local web server that hosts and distributes y
- 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.
Expand All @@ -40,9 +61,11 @@ 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)

*Note: Having `Cross Origin Sharing Requests` issues? [See CORS documentation](/docs/cors.md).*
*Having `Cross Origin Sharing Requests` issues? [See CORS documentation](/docs/cors.md).*

## Install
- Open the command line
- Go to the APEX Front-End Boost directory

#### via Git
```bash
Expand All @@ -62,6 +85,22 @@ npm install apex-frontend-boost

*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).

Expand Down Expand Up @@ -114,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/)
Expand Down
6 changes: 3 additions & 3 deletions docs/cors.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
## Cross Origin Sharing Requests

Starting from ORDS `3.0.3`, we have seen this issue when running APEX applications with APEX Front-End Boost:
Starting from ORDS `3.0.3`, a new security rule concerning `Cross Origin Sharing Requests` conflicts with APEX Front-End Boost when using a VM through port forwarding:

> 403 Forbidden
> The request cannot be processed because this resource does not support Cross Origin Sharing requests, or the request Origin is not authorized to access this resource. If ords is being reverse proxied ensure the front end server is propagating the host name, for mod_proxy ensure ProxyPreserveHost is set to On
This occurs when the server is using ORDS `3.0.3`, `3.0.4` or `3.0.5`.

It does **NOT** occur when using ORDS `3.0.2` or less.
For Apache, please follow the message and set the ProxyPreserveHost parameter to On.

Hopefully that will be fixed in future ORDS version, until then please use ORDS `3.0.2` or less.
Otherwise until then please use ORDS `3.0.2` or less, as the error does **NOT** occur.

Here are some related forum topics:
- https://community.oracle.com/thread/3906326
Expand Down

0 comments on commit 4fd7188

Please sign in to comment.