https://github.com/numtide/serve-go
Like vercel/serve but for production. Serve SPA apps quickly.
https://github.com/numtide/serve-go
Last synced: 3 months ago
JSON representation
Like vercel/serve but for production. Serve SPA apps quickly.
- Host: GitHub
- URL: https://github.com/numtide/serve-go
- Owner: numtide
- License: apache-2.0
- Created: 2021-02-08T14:12:53.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T09:34:22.000Z (12 months ago)
- Last Synced: 2025-04-02T23:55:51.192Z (3 months ago)
- Language: Go
- Homepage:
- Size: 46.9 KB
- Stars: 10
- Watchers: 8
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# serve-go - HTTP web server for SPA
A mostly drop-in replacement to https://www.npmjs.com/package/serve but
written in Go. For when it's time to go to production.
It's dead simple. Not configurable (happy to get PRs).
It serves all the static files from the current directory. And falls backs to
serving the `index.html` if the file is not found. Perfect for Single-Page
Applications (SPA).
## Usage
```
dead-simple application that serves static files from the current directory
Usage: serve-go [options] []
Options:
-listen: Port to listen to (default 3000)
-oembed-url: Sets the oEmbed Link header if set (env: $SERVEGO_OEMBED_URL) (default )
: Folder to serve (default to current directory)
```
## Content Encoding
The server now also handles gzip and brotli content-encoding.
For each file that exists in the work directory, it will also look for a .br
or .gz file, and if it exists, and the client accepts the encoding, serve that
file instead of the original one.
## Example
Here is how to integrate it in a Docker image:
Dockerfile:
```dockerfile
FROM node:15.7.0-alpine3.12 as builder
WORKDIR /app/
# Install dependencies
COPY package.json package-lock.json /app/
RUN npm install
# Build the frontend
COPY . /app/
RUN npm run build
# Create a serve container
FROM ghcr.io/numtide/serve-go:v1.3.0
COPY --from=builder /app/build /site
```