nrsc / README.rst

nrsc - Resource Compiler for Go

nrsc a directory of resource into a Go source file so you can still deploy a single executable as a web server with all the CSS, image files, JS ... included.


go get

Also grab the nrsc script from here

And you'll need zip somewhere in your path.


go build
nrsc <executable> <resource dir> [zip options]


The nrsc package has the following interface

nrsc.Handle(prefix string)

This will register with the net/http module to handle all paths starting with prefix.

When a request is handled, prefix is stripped and then a resource is located and served.

Resource that are not found will cause an HTTP 404 response.

nrsc.Get(path string) Resource
Will return a resource interface (or nil if not found) (see resource interface below). This allows you more control on how to serve.
LoadTemplates(t *template.Template, filenames ...string) (*template.Template, error)
Will load named templates from resources. If the argument "t" is nil, it is created from the first resource.

Resource Interface

func Open() (io.Reader, error)
Returns a reader to resource data
func Size() int64
Returns resource size (to be used with Content-Length HTTP header).
func ModTime() time.Time
Returns modification time (to be used with Last-Modified HTTP header).

Example Code

package main

import (


func indexHandler(w http.ResponseWriter, req *http.Request) {
        fmt.Fprintf(w, "Hello World\n")

func main() {
        http.HandleFunc("/", indexHandler)


MIT (see LICENSE.txt)

Tip: Use camelCasing e.g. ProjME to search for