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:
Directories
¶
| Path | Synopsis |
|---|---|
|
core
|
|
|
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. |
|
healthcheck
Flamingo Package that provides a healthcheck endpoint under the default route /status/healthcheck Usage:
|
Flamingo Package that provides a healthcheck endpoint under the default route /status/healthcheck Usage: |
|
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. |
|
Package framework provides the most necessary basics, such as
|
Package framework provides the most necessary basics, such as |
|
config
Package config provides supporting code for multi-tenant setups
|
Package config provides supporting code for multi-tenant setups |
|
flamingo/mocks
Package mocks is autogenerated Code generated by mockery v1.0.0
|
Package mocks is autogenerated Code generated by mockery v1.0.0 |
|
router
Package provides basic routing functionality for flamingo
|
Package provides basic routing functionality for flamingo |
|
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 |