Skip to content

Commit

Permalink
readme, change log updated
Browse files Browse the repository at this point in the history
  • Loading branch information
ritwickdey committed Oct 26, 2017
1 parent 05f95b6 commit b3818db
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Changelog
| Version | Date | Changelog |
|---|---|---|
| 1.0.0 | 26.10.17 | &mdash; ***[New Feature]*** No need to setup proxy. There is now a way to setup - that is pretty easy & stright-forword. <br><br>&mdash; ***[Enhancement]*** Pop-up window is redesigned. <br><br>&mdash; ***[Bug Fixes]*** Small bug fixes related to the turn on/off switch. <br><br>&mdash; No BETA. General Release. |
0.0.1 | 22.10.17 | Initial Release under BETA |
48 changes: 42 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Live Server - Web Extension - BETA
# Live Server - Web Extension


***[Please give a try. Setup is pretty easy. I need your feedback.]***

<br>
A browser extension that helps you to live reload feature for dynamic content (PHP, Node.js, ASP.NET -- Whatever, it doesn't matter).

**Live Server - Web Extension** is a browser extension that helps you to live reload feature for dynamic content (PHP, Node.js, ASP.NET -- Whatever, it doesn't matter).
This extension is for [`Live Server`](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) (VSCode Extension - required v3.0.0+).
This extension is for [`Live Server`](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) (VSCode Extension - required v3.0.0+).

*[all through you can use the npm package [live-server](https://www.npmjs.com/package/live-server)]*

## Installs:
* **Firefox** : https://addons.mozilla.org/en-US/firefox/addon/live-server-web-extension/
Expand All @@ -20,6 +20,33 @@ It is a simple PHP project.
![](./img/screenshots/live-server-web-extension.gif)

## Setup:
There are two ways to setup `Live Server Web Extension`.

>_[Note: live Server will not able to compile you dynamic pages, you've to use the existing server, live server will help you to reload the pages when you made any change on your code, so that you have not to reload manually browser on every changes]_
1. [Direct Setup](#direct-setup) (Easy One, stright-forword)
2. [Proxy Setup](#proxy-setup)
----------

### Direct Setup

* Install the extension on your browser.

* Install [`VSCode`](https://code.visualstudio.com/download) Editor & [`Live Server`](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) Extension.

* Start `Live Server` (assuming the port of live server is `5500`).

* Now open pop-up menu of `Live Server Web Extension` and check the option `I don't want proxy setup`. [Follow the screenshot](./img/screenshots/live-server-web-extension-easy-setup.png).

* Now at the Actual Server add `http:https://localhost/php/` (assuming your actual server is `http:https://localhost/php/`).
* Now at the `Live Server` add `http:https://localhost:5500/`.

* Now stay on `http:https://localhost/php/`. On every changes, your page will be refreshed automaticly.

----------

### Proxy Setup

* Install the extension on your browser.
* Install [`VSCode`](https://code.visualstudio.com/download) Editor & [`Live Server`](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) Extension.
* Confiure Live Server settings (`.vscode/settings.json`) as follows :
Expand All @@ -39,17 +66,26 @@ It is a simple PHP project.
*/
"liveServer.settings.proxy": {
"enable": true, //switch on :)
"baseUri": "/", //from where you want to proxy.
"proxyUri": "http:https://127.0.0.1:80" //the actual url.
"baseUri": "/", //from where you want to proxy (live server).
"proxyUri": "http:https://127.0.0.1:80" //the actual server url (NOT live server).
},
}

```
* ...And you're done! Just Open Live Server _`(ctrl+shift+p > "Open Live Server")`_ and don't forget to turn on live reload from your browser.
* Note: You have stay on the new url that will be given by Live Server.


## What is new ?

* #### Verision 1.0.0 (26.10.17)
* ***[New Feature]*** No need to setup proxy. There is now a way to setup - that is pretty easy & stright-forword.

* ***[Enhancement]*** Pop-up window is redesigned.

* ***[Bug Fixes]*** Small bug fixes related to the turn on/off switch.

* No BETA. General Release.
* #### Version 0.0.1 (22.10.17)
* Initial Release under BETA.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b3818db

Please sign in to comment.