Facade memorizes one static index.html to use as a minimal site template.
Read the API documentation at godoc.org/github.com/outrightmental/go-facade
Facade (#F4C4D3) provides a convenient way to serve a static frontend UI from a backend server.
Use any frontend that builds to a static build output folder for distribution (e.g. Gulp-Bower-Angular)
Use any webserver that allows different URLs to be routed to different files/servers. (e.g. Nginx)
Separation of concerns, according to The Unix Philosophy.
Use Nginx for what it's great at.
Use a static front end build workflow, and package management (e.g. Bower) for what it's great at.
And use Go to drive your application's logical backend without being concerned by ^
It's power is in how the entire stack is configured to use a webserver (e.g. Nginx) as the first line of HTTP service, to take as much custom work as possible off the production servers.
Check out this blog post for explanation how Facade is different from other frontending solutions.
Our user requests a particular URL, and the webserver (e.g. Nginx):
- Searches in the frontend's static build output folder for distribution, to see if the requested URL matches an exact file. For example,
/(matchesindex.html) or/scripts/app-ddf26c4d.jsor/styles/vendor-f18be9e6.cssor/assets/images/logo.png. If a match is found, the HTTP request is terminated here, by serving the static file. - If no static file is found, pass the request through to the Go webservice with the URL completely intact.
That's where Facade comes in. It will serve our same index.html for every URL that it encounters, with one twist. Inside of our index.html we can configure a set of replacements to be executed at Write time. For example:
<!doctype html>
<html>
<head>
<title>Facade will replace this</title>
<link rel="stylesheet" href="/styles/vendor-f18be9e6.css">
<link rel="stylesheet" href="/styles/app-25ab4bd1.css">
</head>
<body ng-app="freshest" ng-controller="MainCtrl">
<div ui-view=""><facade/><!-- <- Facade will replace this --></div>
<script src="/scripts/vendor-23555feb.js"></script>
<script src="/scripts/app-e39a84b8.js"></script>
</body>
</html>
So when our user visits
https://freshest.io/oauth/authorize
Nginx passes the request through to our Go webserver- perhaps Gorilla Mux -actions are performed silently, followed by the construction of our Go service's HTTP Response.
distPath := Getenv("PATH_TO_FRONTEND_INDEX_DOT_HTML")
frontend := facade.New(distPath)
frontend.PreReplaceAll("../bower_components","/bower_components")
frontend.WillReplaceAll("title","<title>([^<]*)</title>","<title>%s</title>")
frontend.WillReplaceAll("content","<facade/>","%s")
And when it's time to provide the HTTP response:
responsewriter.Header().Set( "Content-Type", "text/html")
responsewriter.WriteHeader( result.Code)
frontend.Write(responsewriter, facade.Casing{
"title":"Freshest",
"content":"<p>This will be replace the <facade/> element in our page</p>"
})
Testing:
go get github.com/stretchr/testify/assert
go test
Next Up: Keepalive (seconds) before rebuilding cache from distFilePath
Next Up: Also inject header tags, e.g. <title> and <description>
- Find an issue that bugs you / open a new one.
- Discuss.
- Branch off, commit, test.
- Make a pull request / attach the commits to the issue.