Skip to content
Newer
Older
100644 71 lines (53 sloc) 2.63 KB
51246b6 @popeindustries update license and docs
authored Dec 11, 2014
1 [![NPM Version](https://img.shields.io/npm/v/buddy-server.svg?style=flat)](https://npmjs.org/package/buddy-server)
2 [![Build Status](https://img.shields.io/travis/popeindustries/buddy-server.svg?style=flat)](https://travis-ci.org/popeindustries/buddy-server)
ef28362 @popeindustries added tests
authored Feb 28, 2013
3
5e44170 @popeindustries update readme
authored Mar 31, 2014
4 # buddy-server
5
51246b6 @popeindustries update license and docs
authored Dec 11, 2014
6 A simple development fileserver, with LiveReload support, for the [buddy](https://github.com/popeindustries/buddy) build tool.
5e44170 @popeindustries update readme
authored Mar 31, 2014
7
51246b6 @popeindustries update license and docs
authored Dec 11, 2014
8 ***WARNING***: default fileserving is very permissive, and will walk the project directory tree looking for the requested file until a match is found. This is inherently insecure, and therefore only recommended for local development.
9
10 When working with the LiveReload feature, it is recommended to install the [LiveReload Chrome extension](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en), or include the following in your html source to initiate the connection:
5e44170 @popeindustries update readme
authored Mar 31, 2014
11
12 ```html
13 <script src="http://localhost:35729/livereload.js"></script>
14 ```
15
16 ## Usage
17
18 ```json
baa5af9 @popeindustries fix typo
authored Aug 25, 2015
19 {
20 "dependencies": {
028c1df @popeindustries update example versions
authored Aug 25, 2015
21 "buddy": "^3.0.0",
22 "buddy-server": "1.0.0"
5e44170 @popeindustries update readme
authored Mar 31, 2014
23 },
24 "buddy": {
25 "server": {
26 "port": 8000,
27 "directory": "www"
28 }
29 }
30 ```
31 ```bash
32 $ buddy watch --serve --reload
51246b6 @popeindustries update license and docs
authored Dec 11, 2014
33 ```
34
35 To use a custom application server instead of the default, specify a `file` path to your server:
36
37 ```json
38 "buddy": {
39 "server": {
40 "port": 8000,
41 "file": "./index.js"
42 }
43 }
44 ```
45
46 Configure environment variables with `env`:
47
48 ```json
49 "buddy": {
50 "server": {
51 "port": 8000,
52 "file": "./index.js",
53 "env": {
54 "DEBUG": "*"
55 }
56 }
57 }
58 ```
59
60 ## License
61
62 (The MIT License)
63
64 Copyright (c) 2011-2015 Pope-Industries &lt;alex@pope-industries.com&gt;
65
66 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:
67
68 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
69
70 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.
Something went wrong with that request. Please try again.