Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ncpa0cpl/goserve
A very simple http static file server written in Go
https://github.com/ncpa0cpl/goserve
Last synced: about 10 hours ago
JSON representation
A very simple http static file server written in Go
- Host: GitHub
- URL: https://github.com/ncpa0cpl/goserve
- Owner: ncpa0cpl
- License: mit
- Created: 2024-01-27T19:13:43.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-06-09T11:13:43.000Z (5 months ago)
- Last Synced: 2024-06-09T12:22:54.613Z (5 months ago)
- Language: Go
- Size: 58.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# goserve
## A very simple http static file server
### Build & Install
#### Install via npm
```bash
npm i -D @ncap0cpl/goserve
```
#### Build yourself
Clone the repo
```bash
git clone https://github.com/ncpa0cpl/goserve
```
Build the binary
```bash
go build -o ./goserve
```
Install the program in your PATH
Copy the binary to a bin directory (assuming `~/.local/bin` is in your PATH)
```bash
cp ./goserve ~/.local/bin
```
### Usage
```
Usage: goserve [options] [directory]
Options:
--help Print this help message.
--loglevel The log level. Default: info
--port The port to serve on. Default: 8080
--redirect Redirect all unmatched routes to a specified url.
--spa Specify a file to send for all unmatched routes.
--chunk-size The size of chunks when streaming. Default: 2048KB
--no-streaming Disables the server ability to process Range requests and sending partial content.
--compress Compress responses using the GZip algorithm.
Hot Module Reload
--aw Alias for '--watch --auto-reload'
--watch When enabled, server will send fs events when files are changed. To listen to these add event listeners to `window.HMR` on client side.
--auto-reload Automatically inject a script to html files that will reload the page on a 'watch' change event.
Cache Headers Options
--maxage The max-age value to set in the Cache-Control header.
--nocache Require browsers to re-validate etag on each resource load.
--noetag Disable ETag generation.
Server Cache
--cache:max Maximum size of all files in the cache. Default: 100MB
--cache:flimit Maximum size of single file that can be put in cache. Default: 10MB
```
To serve files from the `public` directory of the current directory on port 8000:
```bash
goserve --port 8000 ./public
```
#### Node API
Goserve can also be imported in a Node script and spawned using a provided function.
```javascript
import { serve } from '@ncap0cpl/goserve';
const childProcess = serve("path/to/directory", {
port: 3000
});
```
#### Options
##### Auto-reload
When auto-reload is enabled, either via `--auto-reload` or `--aw` flag, a script tag will be injected to every ".html" file that will reload the page every time that file is changed. Note that the `--auto-reload` flag must be used alongside the `--watch` flag.
##### Watch mode
When watch mode is enabled, either via `--watch` or `--aw` flag, to every ".html" file a script tag will be injected enabling listening to file changes within the hosted directory.
Listening to these changes can be done by adding event listeners to `window.HMR` object:
```javascript
HMR.onChange((event) => {
console.log(`file ${event.file} has changed`);
});
HMR.onCreate((event) => {
console.log(`file ${event.file} has been created`);
});
HMR.onDelete((event) => {
console.log(`file ${event.file} has been deleted`);
});
HMR.onRename((event) => {
console.log(`file ${event.oldFile} has been renamed to ${event.file}`);
});
HMR.onCurrentPageChange((event) => {
console.log(`current page's file has changed`);
});
```