livereloadx
Version:
An implementation of the LiveReload 2 server in Node.js
91 lines (57 loc) • 2.21 kB
Markdown
LiveReloadX
===========
[](https://travis-ci.org/nitoyon/livereloadx)

User documentation is under http://nitoyon.github.io/livereloadx/.
This is developer documentation.
Setting up a development environment
------------------------------------
First, clone a git repo by running:
```
git clone git://github.com/nitoyon/livereloadx.git
cd livereloadx
```
Install dependant modules:
```
npm install
```
Check out `gh-pages` branch if you wish to edit project page:
```
git new-workdir . gh-pages gh-pages
```
(ref) [git-new-workdir](https://github.com/git/git/blob/master/contrib/workdir/git-new-workdir), [git-new-workdir-win](https://github.com/dansmith65/git/blob/master/contrib/workdir/git-new-workdir-win)
Running tests
-------------
Run unit tests.
```
grunt mochaTest
```
Run jshint and unit tests.
```
grunt
```
Edit project page
-----------------
Install Ruby and Jekyll:
```
gem install jekyll
```
Install dependant modules:
```
cd gh-pages
npm install
npm install -g grunt-cli
```
Run `grunt`.
```
grunt
```
Now open `http://localhost:35927/_site/` on your browser.
Related Projects
----------------
* [livereload](https://github.com/livereload/): Official version.
* [mklabs/tiny-lr](https://github.com/mklabs/tiny-lr): Tiny reimplementation of LiveReload 2.X server in node.js.
* [gruntjs/grunt-contrib-watch](https://github.com/gruntjs/grunt-contrib-watch#optionslivereload): Grunt task.
* [josh/node-livereload](https://github.com/josh/node-livereload), [clonn/simple-livereload](https://github.com/clonn/simple-livereload), [khoomeister/livereloaded](https://github.com/khoomeister/livereloaded): Reimplementation of LiveReload 1.X server in node.js
* [usualoma/node-livereload-hub](https://github.com/usualoma/node-livereload-hub): Yet another reimplementation of LiveReload 1.X server (Reload via the HTTP request)
* [guard/guard-livereload](https://github.com/guard/guard-livereload): Ruby implementation running with guard.