jeanbza / git-go-websiteskeleton Goto Github PK

A go skeleton for websites.

License: Other

Go 67.36% HTML 32.64%

git-go-websiteskeleton's Introduction

git-go-websiteskeleton

A basic website skeleton in Go that comes with the Gorilla Multiplexer for routing, glog for access and error logging, as well as jquery, bootstrap, and font-awesome for making excellent web apps.

You Will Need

A go environment http://golang.org/doc/install#install
Gorilla mux: go get github.com/gorilla/mux (http://www.gorillatoolkit.org/pkg/mux)
glog: go get github.com/golang/glog
Some basic knowledge of Go's httpd package. See the excellent gowiki tutorial at http://golang.org/doc/articles/wiki/

Installation

cd $GOPATH/src
git clone https://github.com/jadekler/git-go-websiteskeleton.git
cd git-go-websiteskeleton
go run main.go
Navigate to http://localhost:8080

Note: To make it your own project, simply remove the .git file from the project and upload it into your own repository.

Logging

This project contains access and error logging. By default, these logs will be placed in your system's temp folder (on most *nix machines, this is /tmp; on mac, it's /private/var/gobbledegook). To change the log dir, simply run main with -log_dir="/path/to/dir", as in ./main -log_dir="/path/to/dir". If you decide to change the log location (which I recommend), you are in charge of cleaning your log dir periodically. The program's log library (glog) will handle max file sizes, but multiple logs will not be cleaned automatically.

Some more info on what gets captured:

Access logging captures each request served, logging the requestor's IP, the request method, uri, and protocol, the time requested, and the page load time.
Error logging captures the time, error, and a stack trace.

Note: on *nix systems, you can also set the TMPDIR environment variable to specify default output location.

What if I want to use HTTPS?

Check out this fantastic blog post by kaihag.

git-go-websiteskeleton's People

Contributors

Stargazers

Watchers

git-go-websiteskeleton's Issues

Some folders in /static contain .DS_Store files

Look into using multiplexers

Example: http://www.gorillatoolkit.org/pkg/mux

.sass-cache committed - remove

Add database libraries / interfaces

Revert Sass to CSS

Switch from template.Must to using the template pointer directly

As suggested:

template.Must() returns a pointer to a Template type which is cached (stored in RAM). You can execute content on this type with calling the pointer and calling the method ExecuteTemplate().
It is shown here: http://golang.org/doc/articles/wiki/#tmp_10
What you are doing is creating the same Template type over and over again with each request.

Switch imports to using workspace

Things like:

import (
    "git-go-websiteskeleton/src/home"
)

See http://golang.org/doc/code.html#GOPATH

X-frame options

Template rendering improvements

Suggestion from community - needs to be looked into:

You shouldn't reload/reparse templates at each request.
You should render/execute your template on a byte buffer, then copy that buffer to the http.ResponseWriter. Otherwise you will lose either IO errors or template errors. Either way, a bad idea.

Installation instructions

Readme installation instructions are contradictory to How to Write Go Code - Workspaces

main.go imports will need to be updated to correct for $GOPATH difference

Binary file committed - remove

Add flag for -http=":8080" as per godoc

This will allow easier deployment - as in, on a dev box you could use :8080 but a prod box might use :80.

.gitignore needed for binary, sasscache

Security headers

Not using title in layout.html

You are setting the title in Page, but you aren't using it in the layout.html. Is that intentional?

Use golang logging package instead of glog

There was no logging package 2 years ago :)

Fix access log handling (move to console)

Import paths incompatible in godoc

Because this is intended to be installed in $GOPATH/src, godoc can't install it. This may represent a deeper problem - if the go community is making apps that assume installations under $GOPATH/src/, then perhaps we should just adhere to that.

access logging

Hey man, first of all I love the project. Have been using it to learn Go web development and it's been a big help.

I noticed a few flaws in your server access logging and wanted to point them out.

Your access logger takes a response writer, but it's never actually used. So the value for responseBytes is never set or reported, and the status will always be http.StatusOK regardless of what the actual status is.

I think some confusion might have arisen from trying to incorporate gorilla/mux, but the router return from mux.NewRouter actually implements the interface http.Handler and so the code from https://gist.github.com/cespare/3985516 can actually be used pretty much as -is.

I've written up my own gist demonstrating that. It's filled with comments to myself as I was going through both of your implementations line by line and I think it may prove helpful.
https://gist.github.com/pathouse/e74f9dc7919dd9f0ca88