Revel Study

Posted by rightpeter on July 23, 2015

Install Go

Before you can use Revel, first need to install Go.

Set up GOPATH

If you did not create a GOPATH as part of installation, do so now. The GOPATH is a directory tree where all of your Go code will live. Here are the steps to do that:

  1. Make a directory: mkdir ~/gocode
  2. Tell Go to use that as your GOPATH: export GOPATH=~/gocode
  3. Save your GOPATH so that it will apply to all future shell sessions: echo export GOPATH=$GOPATH » ~/.bash_profile

Now your Go installation is complete.

Install git and hg

Git and Mercurial are required to allow go get to clone various dependencies.

  • Installing Git
  • Installing Mercurial

Get the Revel framework

To get the Revel framework, run

go get github.com/revel/revel

This command does a couple 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 get on them as well.

Get the Revel framework

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.

Creating a new Revel application

Use the revel command line tool to create a new application in your GOPATH and run it:

$ export GOPATH="/home/me/gostuff"
$ cd $GOPATH
$ revel new myapp
~
~ revel! http://revel.github.io
~
Your application is ready:
    /home/me/gostuff/src/myapp

You can run it with:
    revel run myapp

$ revel run myapp
~
~ revel! http://revel.github.io
~
2012/09/27 17:01:54 run.go:41: Running myapp (myapp) in dev mode
2012/09/27 17:01:54 harness.go:112: Listening on :9000
Use the **revel** command line tool to create a new application in your GOPATH and run it:

Another Example

$ revel new github.com/myaccount/myapp
$ revel run github.com/myaccount/myapp

Open your browser to http://localhost:9000/ to see a notification that your app is ready.

Revel works