goat
v1.1.2
Published
Serve static files for development, simple and unobstructive.
Downloads
83
Readme
goat
Serve static files for development, simple and unobstructive.
Usage
npm install -g goat
Then add it to your package.json
as a script (you can also install without the -g
for a single project):
{
"name": "my-project",
"scripts": {
"serve": "goat -e ./static/index.html ./dist"
}
}
Which can now be executed in the terminal with npm run serve
.
Available Options
Usage: goat [options]
Options:
-h, --help output usage information
-V, --version output the version number
-e, --entry-file [file] Usually an index.html, defaults to './index.html'
-p, --port [port] Port to run server on, defaults to 3000
-d, --domain-host [host] Host to serve static files at, defaults to 'localhost'
-x, --debug Enable development logging for debugging purposes
-c, --cors Enable cors
Multiple Static Directories
Any additional paths that you append to the end will be served as static directories.
When using -e
, the parent directory is added as a static directory, so no need to add
it manually.
Custom Named Routes
For custom named routes, use the :
(colon) syntax. For example:
goat -e ./static/index.html ./dist/scripts:/scripts
Would make everything in the scripts folder available at localhost:3000/scripts
.
Multiple formats are supported:
.js
-- If you specify a.js
file with a named route, it's assumed to be an express route, e.g.api/users.json:/api/users
. See the example route intest/route.js
which can be ran withgoat -e test/index.html test/route.js:/api/hello
.json
-- Is JSON, so we serve it as JSON, also only if there is an custom named route. This is an easy way to mock an API endpoint..html
-- Sends the html.