Install Go
Before you can use Revel, first you need to install Go.
- See the official Go installation guide.
Set up your GOPATH
If you have not created a GOPATH as part of the installation, do so now. The GOPATH
is a directory where all of your Go code will live. Here is one way of setting it up:
- Make a directory:
mkdir ~/gocode - Tell Go to use that as your GOPATH:
export GOPATH=~/gocode - Save your GOPATH so that it will apply to all future shell sessions:
echo export GOPATH=$GOPATH >> ~/.bash_profile
Note that depending on your shell, you may need to adjust (3) to write the export into a different configuration file (e.g. ~/.bashrc, *~/.zshrc, etc.).
Now your Go installation is complete.
Install git and hg
Git and Mercurial are required to allow go get to clone various dependencies.
Get the Revel framework
To get the Revel framework, run
go get github.com/revel/revel
This command does a couple of things:
- Go uses git to clone the repository into
$GOPATH/src/github.com/revel/revel/ - Go transitively finds all of the dependencies and runs
go geton them as well.
Get and Build the Revel command line tool
The revel command line tool is used
to build, run, and package Revel applications.
Use go get to install:
go get github.com/revel/cmd/revel
Ensure the $GOPATH/bin directory is in your PATH so that you can reference the command from anywhere.
export PATH="$PATH:$GOPATH/bin"
Verify that it works:
$ revel help
~
~ revel! http://revel.github.io
~
usage: revel command [arguments]
The commands are:
new create a skeleton Revel application
run run a Revel application
build build a Revel application (e.g. for deployment)
package package a Revel application (e.g. for deployment)
clean clean a Revel application's temp files
test run all tests from the command-line
Use "revel help [command]" for more information.