| 1 | Live Server
|
| 2 | ===========
|
| 3 |
|
| 4 | This is a little development server with live reload capability. Use it for hacking your HTML/JavaScript/CSS files, but not for deploying the final site.
|
| 5 |
|
| 6 | There are two reasons for using this:
|
| 7 |
|
| 8 | 1. AJAX requests don't work with the `file://` protocol due to security restrictions, i.e. you need a server if your site fetches content through JavaScript.
|
| 9 | 2. Having the page reload automatically after changes to files can accelerate development.
|
| 10 |
|
| 11 | If you don't want/need the live reload, you should probably use something simpler, like the following Python-based one-liner:
|
| 12 |
|
| 13 | python -m SimpleHTTPServer
|
| 14 |
|
| 15 |
|
| 16 | Installation
|
| 17 | ------------
|
| 18 |
|
| 19 | You need node.js and npm. You should probably install this globally.
|
| 20 |
|
| 21 | **Npm way**
|
| 22 |
|
| 23 | npm install -g live-server
|
| 24 |
|
| 25 | **Manual way**
|
| 26 |
|
| 27 | git clone https://github.com/tapio/live-server
|
| 28 | cd live-server
|
| 29 | npm install # Local dependencies if you want to hack
|
| 30 | npm install -g # Install globally
|
| 31 |
|
| 32 |
|
| 33 | Usage
|
| 34 | -----
|
| 35 |
|
| 36 | Issue the command `live-server` in your project's directory.
|
| 37 |
|
| 38 | This will automatically launch the default browser (you should have `index.html` present). When you make a change to any file, the browser will reload the page - unless it was a CSS file in which case the changes are applied without a reload.
|
| 39 |
|
| 40 | You can configure the port to be used by setting `PORT` environment variable prior to launching the server.
|
| 41 |
|
| 42 |
|
| 43 | Troubleshooting
|
| 44 | ---------------
|
| 45 |
|
| 46 | Open your browser's console: there should be a message at the top stating that live reload is enabled. If there are errors, deal with them. You will need a browser that supports WebSockets.
|
| 47 |
|
| 48 |
|
| 49 | How it works
|
| 50 | ------------
|
| 51 |
|
| 52 | The server is a simple node app that serves the working directory and its subdirectories. It also watches the files for changes and when that happens, it sends a message through a web socket connection to the browser instructing it to reload. In order for the client side to support this, the server injects a small piece of JavaScript code to each requested html and php files. This script establishes the web socket connection and listens to the reload requests.
|
| 53 |
|
| 54 |
|
| 55 | License
|
| 56 | -------
|
| 57 |
|
| 58 | Uses MIT licensed code from [Connect](https://github.com/senchalabs/connect/) and [Roots](https://github.com/jenius/roots).
|
| 59 |
|
| 60 | (MIT License)
|
| 61 |
|
| 62 | Copyright (c) 2012 Tapio Vierros
|
| 63 |
|
| 64 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
| 65 |
|
| 66 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
| 67 |
|
| 68 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|