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
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
core
|
|
|
healthcheck
Package healthcheck provides a healthcheck endpoint under the default route /status/healthcheck Usage: Register your own Status via Dingo: injector.BindMap(new(healthcheck.Status), "yourServiceName").To(yourServiceNameApi.Status{})
|
Package healthcheck provides a healthcheck endpoint under the default route /status/healthcheck Usage: Register your own Status via Dingo: injector.BindMap(new(healthcheck.Status), "yourServiceName").To(yourServiceNameApi.Status{}) |
|
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 |