flamingo

package module

v3.0.0-alpha1 Latest Latest Go to latest Published: Jan 22, 2019 License: OSL-3.0 Imports: 14 Imported by: 15

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/i-love-flamingo/flamingo

README ¶

Flamingo

What is Flamingo

Flamingo is a go based, framework for pluggable web projects. It is used to build scalable and maintainable web-applications. It's architecture is especially useful to build "frontends" for your headless microservice architecture.

open source
written in go
easy to learn
fast and flexible

Go as simple, powerful and typesafe language is great to implement and scale serverside logic. Flamingo has a clean architecture and uses "Domain Driven Design" and "Ports and Adapters" Layering - with clean and clear dependencies in mind.

The Flamingo Ecosystem

With "Flamingo Commerce" and "Flamingo Carotene" you get your toolkit for building Blazing fast commerce experience layers

Flamingo Commerce

Contains flamingo modules that provide „domain“, „application“ and „interface“ logic around commerce features
According to „ports and adapters“ these modules can be used with your own „Adapters“ to interact with any API or microservice you want.

Flamingo Carotene

Is the frontend build pipeline featuring pug and atomic design pattern

It can be used to implement modern and blazing fast commerce web applications.

Getting started

You may want to start reading in the docs:

[Getting Started](docs/0. Introductions/1. Getting Started.md)
[Flamingo Feature Overview](docs/1. Flamingo Basics/1_Flamingo Feature Overview.md)

External Links:

Documentation ¶

Index ¶

func App(modules []dingo.Module, options ...option)
func ConfigDir(configdir string) option
type AppShutdownEvent
type AppStartupEvent

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func App ¶

func App(modules []dingo.Module, options ...option)

App is a simple app-runner for flamingo

func ConfigDir ¶

func ConfigDir(configdir string) option

Types ¶

type AppShutdownEvent ¶

type AppShutdownEvent struct {
	AppModule dingo.Module
}

AppShutdownEvent is dispatched on app shutdown

type AppStartupEvent ¶

type AppStartupEvent struct {
	AppModule dingo.Module
}

AppShutdownEvent is dispatched on app startup

Source Files ¶

View all Source files

app.go

Directories ¶

Path	Synopsis
core
auth
auth/application
auth/application/fake
auth/application/mocks
auth/application/store
auth/domain
auth/interfaces
auth/interfaces/fake
cache
canonicalUrl
canonicalUrl/application
canonicalUrl/interfaces
captcha
captcha/application
captcha/domain
captcha/interfaces
circuitbreaker
cmd
cmd/interfaces/command
csp
csrfPreventionFilter
csrfPreventionFilter/application
csrfPreventionFilter/application/mocks
csrfPreventionFilter/interfaces
csrfPreventionFilter/interfaces/templatefunctions
form This package provides helper to use and deal with (web)forms in your "interfaces" layer (e.g.	This package provides helper to use and deal with (web)forms in your "interfaces" layer (e.g.
form/application This package belongs to the form module.	This package belongs to the form module.
form/domain Domain package of the "form" module.	Domain package of the "form" module.
form2
form2/application
form2/application/fake
form2/domain
form2/domain/formData
form2/domain/mocks
form2/domain/validators
gotemplate
healthcheck Flamingo Package that provides a healthcheck endpoint under the default route /status/healthcheck Usage: Register your own Status via Dingo: injector.BindMap((*healthcheck.Status)(nil), "yourServiceName").To(yourServiceNameApi.Status{})	Flamingo Package that provides a healthcheck endpoint under the default route /status/healthcheck Usage: Register your own Status via Dingo: injector.BindMap((*healthcheck.Status)(nil), "yourServiceName").To(yourServiceNameApi.Status{})
healthcheck/domain/healthcheck
healthcheck/interfaces/controllers
internalauth
internalauth/application
internalauth/domain
locale
locale/application
locale/domain
locale/interfaces/templatefunctions
logrus
profiler
pugtemplate
pugtemplate/puganalyse
pugtemplate/pugjs
pugtemplate/pugjs/parse Package parse builds parse trees for templates as defined by text/template and html/template.	Package parse builds parse trees for templates as defined by text/template and html/template.
pugtemplate/templatefunctions
redirects
redirects/infrastructure
requestTask
requestlogger
robotstxt
security
security/application
security/application/mocks
security/application/role
security/application/role/mocks
security/application/role/provider
security/application/role/provider/mocks
security/application/voter
security/application/voter/mocks
security/domain
security/domain/mocks
security/interface/controller
security/interface/middleware
security/interface/middleware/mocks
zap
zap/domain
framework Package framework provides the most necessary basics, such as - service_locator - router - web (including context and response) - web/responder Additionally it provides a router at /_flamingo/json/{handler} for convenient access to DataControllers Additionally it registers two template functions, `get(...)` and `url(...)`	Package framework provides the most necessary basics, such as - service_locator - router - web (including context and response) - web/responder Additionally it provides a router at /_flamingo/json/{handler} for convenient access to DataControllers Additionally it registers two template functions, `get(...)` and `url(...)`
config Package config provides supporting code for multi-tenant setups	Package config provides supporting code for multi-tenant setups
controller
dingo
event
event/mocks
flamingo
flamingo/mocks Package mocks is autogenerated Code generated by mockery v1.0.0	Package mocks is autogenerated Code generated by mockery v1.0.0
opencensus
prefixrouter
router Package provides basic routing functionality for flamingo	Package provides basic routing functionality for flamingo
router/mocks
session
template
testutil
web
web/responder Package responder are basically helper for generating responses.	Package responder are basically helper for generating responses.
web/responder/mocks Code generated by mockery v1.0.0 Code generated by mockery v1.0.0 Code generated by mockery v1.0.0 Code generated by mockery v1.0.0	Code generated by mockery v1.0.0 Code generated by mockery v1.0.0 Code generated by mockery v1.0.0 Code generated by mockery v1.0.0

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL