GOPATH
is no longer supported.
Please see this blog post for more information https://blog.gobuffalo.io/the-road-to-1-0-requiring-modules-5672c6b015e5.
Directory structure
Buffalo provides you a minimal directory structure to work on your project. This structure keeps the project clean, and allow the generators to work. Don't try to reinvent the wheel, and let Buffalo buy you more time to do the interesting part of your app! :)
Now that you have a minimal new project, let's go through its contents.
The root directory
Here is the structure of a Buffalo project:
go/
— GOPATH root.src/
— Go sources directorygithub.com/username/myapp/
— your app rootactions/
assets/
grifts/
locales/
models/
public/
templates/
tmp/
database.yml
main.go
actions
This directory handles the Controller part of the MVC pattern. It contains the handlers for your URLs, plus:
- the
app.go
file to setup your app & routes, - the
render.go
file to setup the template engine(s).
assets
This directory contains raw assets which will be compiled/compressed & put in the public
directory.
grifts
This directory contains the tasks powered by grift.
locales
app.go
file in the actions
directory.
This directory is used by the i18n system. It will fetch the translation strings from here.
models
This directory handles the Model part of the MVC pattern. It contains the models.go
file to initialize the datasource connection, and the model files to reflect objects from the datasource.
public
This directory contains the public (compiled/compressed) assets. If you use webpack, it will put its assets in this directory.
templates
This directory handles the View part of the MVC pattern. It contains the project templates, used to render the views.
tmp
This directory is used by the buffalo dev
command to rebuild your project on every change. The temporary files that Buffalo works with are put here.
database.yml
This file contains the database configuration for pop/soda.
main.go
This file bootstraps your app and starts it.
Next Steps
- Configuration - Manage your app configuration.