README
¶
Go Bootstrap
Web framework in Go focused on simplicity and flexibility.
Main features:
- Nested structure
- Lose coupled modules
- Pluggable DB layer
- Memcache support
- CLI commands support
- URL reverse
- JWT based sessions
- Pongo2 templates
- Type safe config
After cloning repo you have to rename all github.com/alehano/gobootstrap to
{your project path}. Feel free to modify source code as you want.
Project Structure:
Project has a nested structure. Top level parts can be used by many lower level parts.
For example, top level /helpers package should contain more common helpers
than more specific lower level /views/contacts/helpers.go.
Also, files under common dirs considered as upper level's. For example,
/views/common/tmpl dir should contain files using by multiple views, but
/views/admin/tmpl should contain files using only from /admin section.
actions
Complex tasks usually involving multiple models interactions.
config
Centralized storage of config parameters and some others items using in many parts of the App, like Cache Keys.
helpers
Set of App specific helpers methods. Independent from other parts of the App.
For more common helpers use github.com/alehano/gohelpers.
models
Data structures and data access layer (Manager) with DB persistence layer (Storage). Models are independent from other parts instead of Config. Models can send PubSub messages to communicate with each other and trigger other actions.
services
Background jobs.
sys
Core components of the App. Used in many others components. Can depend on Config, Helpers and external packages. Often contain stores of some items like URL routes or CLI commands.
utils
Utils more complex than helpers, but also independent from other parts of the App.
views
Representation layers split by modules. Contains web handlers, templates, static files (img, js, css) and more. Handlers mostly use model Managers to get and save data.
Example config file config.yml
Config file can be loaded either by set environment variable "APP_CONFIG" with full path to .yml config file or by putting config.yml to the app working directory.
debug: true
port: 8000
project_path: "/Users/alehano/Development/go/src/github.com/alehano/gobootstrap"
website_protocol: "https://"
website_domain: "example.com"
admin_login: "admin"
admin_password_hash: "$2a$10$5gCLP.GlOVBVFLtrzhoxfO5wsT0eiH7IsjzupA7ukTyI/znLFotHu" # password is "admin"
jwt_secret: "secret"
Command line interface
Framework has several built-in CLI command. To get list of commands, just run it without parameters.
Up and running
To start server, run go run main.go run_server (you have to have defined APP_CONFIG environment variable with full path to a config file).
Some of used external packages:
Here is a list of used packages. You might have to read their docs to use them.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Actions more complex than models.
|
Actions more complex than models. |
|
Config package contains different typed parameters accessible by .Get(), as well as some structures like cache keys generator.
|
Config package contains different typed parameters accessible by .Get(), as well as some structures like cache keys generator. |
|
Common App specific helpers.
|
Common App specific helpers. |
|
Data structures and persistence methods
|
Data structures and persistence methods |
|
example
Example model and data manager It contains initialized Manager (`Man`) to get|set data: `example.Man.Get(123)`
|
Example model and data manager It contains initialized Manager (`Man`) to get|set data: `example.Man.Get(123)` |
|
Background jobs.
|
Background jobs. |
|
Core components of the App.
|
Core components of the App. |
|
cmd
CLI Commands using Cobra package
|
CLI Commands using Cobra package |
|
db
Database connectors
|
Database connectors |
|
log
Wrapper for Logrus log.WithFields(log.Fields{ "key": "val", "key2": "val2", }).Info("Index page")
|
Wrapper for Logrus log.WithFields(log.Fields{ "key": "val", "key2": "val2", }).Info("Index page") |
|
memcache
Wrapper for Memcached
|
Wrapper for Memcached |
|
pubsub
Publish-Subscriber local service Can be replaced by distributed one (e.g.
|
Publish-Subscriber local service Can be replaced by distributed one (e.g. |
|
Independent utils.
|
Independent utils. |
|
pause
Pause sleeps on each step for some time (increasing in linear progression).
|
Pause sleeps on each step for some time (increasing in linear progression). |
|
views
|
|
|
common
Common parts used in other views
|
Common parts used in other views |