revel/revel.github.io

Revel manual and docs

Revel Framework

A high productivity, full-stack web framework for the Go language.

Current Version: 1.1.0 (2022-04-11)

Supports go.mod package management

Quick Start

Install Revel:

go install github.com/revel/cmd/revel@latest

Create & Run your app:

revel new -a my-app -r

Open http://localhost:9000 in your browser and you should see "It works!"

Community

• Gitter
• StackOverflow

Learn More

• Manual, Samples, Godocs, etc
• Apps using Revel
• Articles Featuring Revel

Contributing

• Contributing Code Guidelines
• Revel Contributors

Contributors

revel.github.io's Issues

i18n param config docs

revel/revel#1186

Where to put 'user-id' of authenticated user

Hi,

Happy New Year and thanks for great framework!

I am building an API using Revel and want to secure it using token mechanism.
I want something simple ( I don't need role based ) and powerful at the same time.
So I created a simple config file, where routes and policies ( anonymous / authorized ) are defined.

Then I use revel.InterceptMethod(authmodule.Secure, revel.BEFORE) to validate each request for proper token.
After the user is successfully validated, I want to put his 'userId' somewhere so I could use it in controllers. I don't think session is a good place as all my servers are stateless and authentication token is sent with each http request.

What is the best place to put it?

Thank you in advance!

Add favicon

Please add a favicon to make the page easier to find for people with lots of tabs opened!

TODO: Quickstart

Need to rip the quickstart from @notzippy

http://reveldoc.notzippy.com/quickstart/

Assumed target is

quickstart/

systemd, upstart, init, etc

Add some docs examples for runtime config

update banner messages

the docs which show the banner message should be updated to reflect the change to revel.github.io

Please add info about people behind Revel.

Hi
I would like to know more about people behind Revel. Who is doing it, what is their motivation. What guarantee I have that this project will be kept alive in future (is it backed by some company? What if authors will get new job? Or family? etc) Will there be support? generally I would like to evaluate not just by features but also by stability-maturity of the team behind it.

So the issue: please add some info to the website, that addresses my above questions.

Thanks

Pre text is white

I see all <pre> wrapped code examples as white text. Impossible to read.

TODO: render

Explain more abounr c.Render()

explain c.RenderTemplate()

Also demo RenderText()

Generating godoc files is broken

https://github.com/revel/revel.github.io/blob/master/docfile.go

Seems for go1.3's godoc that we can't simple provide 1 template override e.g. package.html. It complains that other template are missing.

This is a big issue since we want to enhance our godoc instructions to be as useful as the current manual. The biggest reason we want to do this is so the manual will stay up to date if we don't have to update it separately as the code evolves.

legibility of figure .highlight .nt very difficult to read against #111 background

the syntax theme for the site uses jekyll-github.css, which looks great against its default #f8f8f8 background-color, but there is an overriding background color of #111 which makes the .highlight .nt, which is navy, very difficult to read.

is there any interest in changing this to improve the legibility?

see for example: http://revel.github.io/tutorial/firstapp.html

TODO: Explain Skel

Explain the skeleton more..

the controlers and the fact its used in modulles..

and closelly intertwined

Update test runner screenshot

Explain fork.branch

Need to stick this in docs

revel/revel#1129

static site gen using hugo

you might want to use hugo.

its go based and porting is very easy

http://hugo.spf13.com/

Update manual for app.conf

http://revel.github.io/manual/appconf.html

• logging
• any other missing/new features eg. revel/revel#719

"Creating a New Revel Application" fails because of unmet dependencies

In https://revel.github.io/tutorial/createapp.html, it seems like running myapp fails due to unmet dependencies, as shown below.

• What steps should the user take to prevent these errors?
• Would it make sense to add these steps to tutoria/gettingstarted.md or tutorial/createapp.md?

[rolfedh@fedora-desktop ~]$ export GOPATH="/home/rolfedh/gocode"
[rolfedh@fedora-desktop ~]$ cd $GOPATH
[rolfedh@fedora-desktop gocode]$ ls
bin  myapp  pkg
[rolfedh@fedora-desktop gocode]$ rm -rf myapp/
[rolfedh@fedora-desktop gocode]$ revel new -a myapp
Revel executing: create a skeleton Revel application
Your application has been created in:
   /home/rolfedh/gocode/myapp

You can run it with:
   revel run -a  myapp
[rolfedh@fedora-desktop gocode]$ revel run -a  myapp
ERROR 19:37:08   file.go:372: Error                                    seeking=github.com/revel/revel count=1 App Import Path=github.com/revel/revel filesystem path=github.com/revel/revel errors="[-: no required module provides package github.com/revel/revel; to add it:\n\tgo get github.com/revel/revel]" 
Downloading related packages ... completed.
Revel executing: run a Revel application
WARN  19:37:10 harness.go:175: No http.addr specified in the app.conf listening on localhost interface only. This will not allow external access to your application 
Changed detected, recompiling
Parsing packages, (may require download if not cached)... Completed
/home/rolfedh/gocode/go/pkg/mod/github.com/revel/[email protected]/cache/memcached.go
WARN  19:37:11  build.go:420: Could not find in GO path                file=../../go/pkg/mod/github.com/revel/[email protected]/cache/memcached.go 
ERROR 19:37:11 harness.go:239: Build detected an error                  error="Go Compilation Error (in ../../go/pkg/mod/github.com/revel/[email protected]/cache/memcached.go:11): no required module provides package github.com/bradfitz/gomemcache/memcache; to add it:" 

Error compiling code, to view error details see proxy running on http://:9000


Time to recompile 405.916071ms

Line 61 of gettingstarted.md omits the `revel` command.

https://revel.github.io/tutorial/gettingstarted.html contains a typo. It is missing the revel command on line 61. The command displays the first line of the output instead, $ Usage:

Godoc upstream

Should we not link to documentation at http://godoc.org/github.com/revel/revel
(maybe with a template tag etc to make it easier)
these we can pretty well guarantee are up to date.

Just a thought

Use godoc.com, abandon inbuilt godoc

I've just been playing around with a script to examine the output..

My conclusion is that it gonna be a pain in the butt.. for example linking from the test suite to an url.Values, calls /pkg/net/url/#Values

I understand that we want the stuff to look nice in revel manual, and no one as much as myself, but i prefer the easier (and maybe more complicant option), instead of having to maintain also...

As far as the "page goes".. I call it the "api-docs" page..
and I think we would just links to all the revel core, modules, etc.. third parties.. or godocs..

httpAddr config docs

See revel/cmd#61

Todo

• add to http://revel.github.io/manual/appconf.html

TODO for 0.14

• skeleton moved = revel/cmd#58

Pete's TODO

TODO

• Explain go env command to check settings
• Add link from revel command to "getting started", ie install and gopath

Update Params doc

https://revel.github.io/manual/binding.html

Doc is out of date.

docs vs modules

Am updating docs so need clarifications on a some module issues..

look here http://revel-docs.daffodil.uk.com/manual/modules.html

---

An empty import path disables the module:

 module.mymodulename =

is that the same as

 #module.mymodulename = /my/dodgy/mod

Are there any other implications..?? eg not imported etc ??

I assume that what we want is that if the module path not exits crash, and not imported ??

what happens if I import module and invalid path?

spelling error in documentation

In the Config section of the database section in the documentation, a code example contains a method argument spelling error. Here is an image (error in line 3 of the code):

TL;DR: localhost is spelled locahost

Install notes out of date

The install notes here:

https://revel.github.io/tutorial/gettingstarted.html

Are out of date. When you try to use the go get command to install revel it fails due to changes in the way modules are installed.

$ go get github.com/revel/revel
go: go.mod file not found in current directory or any parent directory.
        'go get' is no longer supported outside a module.
        To build and install a command, use 'go install' with a version,
        like 'go install example.com/cmd@latest'
        For more information, see https://golang.org/doc/go-get-install-deprecation
        or run 'go help get' or 'go help install'.

Update template manual page

TODO

• document url helper
• remove eq
• update "improve this page" buttons to point to develop branch

Quick start steps still reference the old repo

It looks like this repo got a massive search/replace of robfig, but the quick start steps are still out of date.

JSON param binding docs

See revel/revel#1173

TODO

• add clear happy path examples to "Request Paramaters" in a new JSON section

docs/ directory

What is this and what does it do ?

Docs for past releases

One thing that has been frustrating while using Ember JS is that their doc website only shows the latest version of the docs. My company doesn't update its 3rd party libraries often and so we aren't always using the latest code. I need to see the correct docs for my version

Revel, I'm sure, will have the same issue. We need to make past versions of the docs viewable.

@pedromorgan Thoughts?

style + bootstrap

• Upgrade to bootstrap 3

revelframework.com

This is the way we wanna go from now.. imho..

I just done an update, and jekyll/etc is complaing and cant compile..

So stuff jekyll.. lets move on to revel on revel please..
and from
https://github.com/revel/revelframework.com/tree/rf-site

Dbugging in intellij

Add to docs
from revel/revel#1072

Just for other people with the same question.

Create your project, for this example i will be using canonical "revel new github.com/myaccount/my-app"
"revel run github.com/myaccount/my-app" to generate tmp/main.go - this file is needed by intellij
Shutdown the running server
Create project in intellij from existing sources
Create run configuration and in "Program arguments" add "-importPath github.com\myaccount\my-app -srcPath \src -runMode dev"
Point "File" to \src\github.com\myaccount\my-app\app\tmp\main.go
In "before launch" add "Run external tool". There:
Program: \bin\revel.exe
Paramerets: build github.com/myaccount/my-app
This works for me on Windows 8

Fix "Improve this Page" links to point to new repo

Currently the "Improve this Page" links point to the old gh-pages branch in the revel/revel repository. This (and possibly other links) need to reflect the move to this repository.
See revel/revel #535 for more info.

Issue with Hello World App docs

While running through the tutorial and Hello World App, I get:

Not Found
No matching route found:  /App/Hello?myName=Steve

I have changed the controller and added the html file in the App folder. Something mismatched with a new version?

I'm on go version go1.9.2 windows/amd64.

Thanks!

Remove duplicate/conflicting command from tutorial

The first command in the tutorial, https://revel.github.io/tutorial/createapp.html, sets the GOPATH to a different value than the value given in https://revel.github.io/tutorial/gettingstarted.html#set_up_your_gopath.

This might confuse users and seems like an unnecessary duplication.

Would it make sense to remove the following line from gettingstarted.md?

$ export GOPATH="/home/me/gostuff"

Docs Deploy

Couple issues

Where are the docs build and released?

I assume this is not github pages right ?
So am compeltely perplexed where the docs "compilation" happen, is it on a workstation, server, jenkins ? or compiled by github upon commit ???

Multiversion

• need to get a grip on versioning, ie master and next
• To deal with this, maybe we copy django and have a current docs, at latest and others in dirs
  ie

/master/manual/index.html
/0.11/manual/index.html << even a symlink to above
/0.9/manual/index.html << legacy and nuked after 1.5 years
/next/manual/index.html << docs for next version

Missing Namespace manual page

http://revel.github.io/manual/namespace.html 404
from http://revel.github.io/manual/concepts.html
https://github.com/revel/revel.github.io/search?utf8=%E2%9C%93&q=namespace&type=
there is no namespace manual page

Getting Started Improvements

• No need to go get revel lib
• Need to warn (or provide windows examples) when setting env vars that windows vs *nix does it differently

revel/revel binary

There seems to be a binary at revel/revel ?

what is this and its purpose

Multi Languague

Make it more multilingual also.. (I think in Welsh when i code docs = idiots language)

Also we need chinese and nippongo translations..

Warn users about test go files,

Go test files are written with _test.go Revel test files cannot be written this way since in revel we compile these files to run them

Docs Master = Pedro

Right I've had enough of waiting..

I think I got a good grip on what we want, as an end user..

So unless anyone complains..
I will nominate myself as docs master..
so any docs issues I wanna know..

The deal is that

1. we merge develop into master NOW today.. to make docs proper..