README
¶
My first ever Go project
gopherblog 
A blog about Go, written in Go. Located at www.gopherblog.org
TL;DR
# Fetch code and install binary
go get github.com/gbbr/gopherblog/...
go install github.com/gbbr/gopherblog/...
# Set up database and admin user
./install.sh
bower install
# Run HTTP server on localhost:8080
gopherblog -db="user[:pass]@tcp(host:port)/gopherblog"
Requirements
The system assumes that you have successfully installed the following requirements:
- A running version of MySQL
- The Go language installed, with correct environment variables (GOPATH, GOROOT, etc)
After all of the above are installed, do go get github.com/gbbr/gopherblog/... to install the blog and its dependencies.
Setting up the database
To set up the database you need to run the following command:
chmod +x install.sh; ./install.sh
Follow the on-screen instructions and enter your database host and credentials. The second section will ask you to create the Admin credentials and Display Name which you will use to create posts on the blog. The Display Name that you enter here will be displayed on your posts' pages.
Running the blog
First we must compile the main package and all its dependencies into a binary. To do this we run (in the gopherblog directory):
go install
This should create the binary called gopherblog in your $GOPATH/bin folder. On my machine, for example, I naively run the blog as:
gopherblog -db="root:root@tcp(localhost:3306)/gopherblog"
The following command-line flags are provided:
| Flag | Default Value | Description |
|---|---|---|
| -db= | root@tcp(localhost:3306)/gopherblog | Database connection string. |
| -host= | localhost | Hostname that the server runs on |
| -port= | 8080 | Port to listen on for HTTP connections |
| nocache | Setting this flag will recompile the HTML templates on every request |
Navigating
| Route | Description |
|---|---|
| / | Home page of the blog, displays a list of posts |
| /tag/:name | Filter posts by tag name |
| /post/:slug | Displays a post with the given slug |
| /login | Displays login page |
| /manage | Manage your posts (requires authentication) |
| /edit/:id | Edit a post with the given ID |
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
This package holds the HTTP handlers and the templating engine.
|
This package holds the HTTP handlers and the templating engine. |
|
This package contains the blog's models and holds the database connection globally but as an unexported value.
|
This package contains the blog's models and holds the database connection globally but as an unexported value. |
|
testdb
Package testdb assists with creating and managing a database destined for testing.
|
Package testdb assists with creating and managing a database destined for testing. |