Welcome to Revel

A high-productivity web framework for the Go language.

Setup Git hooks:

pnpm install
pnpm run prepare

Setup Environment:

cp .env.example .env

Sync Proto:

brew install yq # For Mac
./scripts/sync-proto

Start the web server:

revel run

Go to http://localhost:9000/ and you'll see:

"It works"

Start the web server with docker:

docker-compose build docker-compose up

Code Layout

The directory structure of a generated Revel application:

conf/             Configuration directory
    app.conf      Main app configuration file
    routes        Routes definition file

app/              App sources
    init.go       Interceptor registration
    controllers/  App controllers go here
    views/        Templates directory

messages/         Message files

public/           Public static assets
    css/          CSS files
    js/           Javascript files
    images/       Image files

tests/            Test suites

Help

• The Getting Started with Revel.
• The Revel guides.
• The Revel sample apps.
• The API documentation.