mirror of
https://github.com/kevin-DL/revel-cmd.git
synced 2026-01-20 14:15:09 +00:00
Tidy up skeleton
This commit is contained in:
@@ -1,75 +1,43 @@
|
||||
# Welcome to Revel
|
||||
|
||||
## Getting Started
|
||||
|
||||
A high-productivity web framework for the [Go language](http://www.golang.org/).
|
||||
|
||||
|
||||
### Start the web server:
|
||||
|
||||
revel run myapp
|
||||
|
||||
Run with <tt>--help</tt> for options.
|
||||
revel run myapp
|
||||
|
||||
### Go to http://localhost:9000/ and you'll see:
|
||||
|
||||
"It works"
|
||||
"It works"
|
||||
|
||||
### Description of Contents
|
||||
## Code Layout
|
||||
|
||||
The default directory structure of a generated Revel application:
|
||||
The directory structure of a generated Revel application:
|
||||
|
||||
myapp App root
|
||||
app App sources
|
||||
controllers App controllers
|
||||
init.go Interceptor registration
|
||||
models App domain models
|
||||
routes Reverse routes (generated code)
|
||||
views Templates
|
||||
tests Test suites
|
||||
conf Configuration files
|
||||
app.conf Main configuration file
|
||||
routes Routes definition
|
||||
messages Message files
|
||||
public Public assets
|
||||
css CSS files
|
||||
js Javascript files
|
||||
images Image files
|
||||
conf/ Configuration directory
|
||||
app.conf Main app configuration file
|
||||
routes Routes definition file
|
||||
|
||||
app
|
||||
app/ App sources
|
||||
init.go Interceptor registration
|
||||
controllers/ App controllers go here
|
||||
views/ Templates directory
|
||||
|
||||
The app directory contains the source code and templates for your application.
|
||||
messages/ Message files
|
||||
|
||||
conf
|
||||
public/ Public static assets
|
||||
css/ CSS files
|
||||
js/ Javascript files
|
||||
images/ Image files
|
||||
|
||||
The conf directory contains the application’s configuration files. There are two main configuration files:
|
||||
|
||||
* app.conf, the main configuration file for the application, which contains standard configuration parameters
|
||||
* routes, the routes definition file.
|
||||
tests/ Test suites
|
||||
|
||||
|
||||
messages
|
||||
## Help
|
||||
|
||||
The messages directory contains all localized message files.
|
||||
|
||||
public
|
||||
|
||||
Resources stored in the public directory are static assets that are served directly by the Web server. Typically it is split into three standard sub-directories for images, CSS stylesheets and JavaScript files.
|
||||
|
||||
The names of these directories may be anything; the developer need only update the routes.
|
||||
|
||||
test
|
||||
|
||||
Tests are kept in the tests directory. Revel provides a testing framework that makes it easy to write and run functional tests against your application.
|
||||
|
||||
### Follow the guidelines to start developing your application:
|
||||
|
||||
* The README file created within your application.
|
||||
* The [Getting Started with Revel](http://revel.github.io/tutorial/index.html).
|
||||
* The [Getting Started with Revel](http://revel.github.io/tutorial/gettingstarted.html).
|
||||
* The [Revel guides](http://revel.github.io/manual/index.html).
|
||||
* The [Revel sample apps](http://revel.github.io/samples/index.html).
|
||||
* The [Revel sample apps](http://revel.github.io/examples/index.html).
|
||||
* The [API documentation](https://godoc.org/github.com/revel/revel).
|
||||
|
||||
## Contributing
|
||||
We encourage you to contribute to Revel! Please check out the [Contributing to Revel
|
||||
guide](https://github.com/revel/revel/blob/master/CONTRIBUTING.md) for guidelines about how
|
||||
to proceed. [Join us](https://groups.google.com/forum/#!forum/revel-framework)!
|
||||
|
||||
Reference in New Issue
Block a user