cookiecutter-golambda is an AWS Lambda function generator. It creates opinionated structure for serverless functions written in Golang. cookiecutter-golang follows Hexagonal Architecture aka Ports and Adapters pattern, you can read more here.
- Cookiecutter
- Docker
- AWS SAM CLI
- Golang 1.12.x and above
cookiecutter https://github.com/Ryanair/cookiecutter-golambda
and then go to generated directory and run Lambda function by inovking
make
-
Run your AWS Lambda function locally and use API Gateway as a trigger.
-
Use either DynamoDB or in memory storage adapter for your persistence layer.
-
Execute by using pre-defined set of Makefile commands.
-
Handle environment variables by using envconfig
-
Use Uber's zap logging library.
Generated code will be structured as follows:
├── build
├── cmd
│ ├── creation
│ │ └── main.go
│ └── retrieval
│ └── main.go
├── configs
│ └── local.json
├── deployments
├── internal
├── pkg
├── go.mod
├── go.sum
└── Makefilelocal configurations and scripts, such as: start local DynamoDB container, setup DynamoDB table, etc.
Lambda functions main.go files. Split logic into multiple functions and avoid creating function monolith.
configuration file templates for each environment.
SAM template with all required AWS resources. Your function and all dependent infrastructure components defined within template.yml will be deployed on AWS cloud.
code that is not related to business logic goes here, e.g. wrapper around Uber's zap logger.
business logic implementation that follows Hexagonal Architecture.
go module definition and all required 3rd party modules.
default configuration for common commands.
cookiecutter-golambda is under the MIT license
Copyright (c) 2019 Ryanair Labs
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.