https://github.com/vsrc/samg
AWS SAM boilerplate generator command line utility
https://github.com/vsrc/samg
Last synced: about 1 year ago
JSON representation
AWS SAM boilerplate generator command line utility
- Host: GitHub
- URL: https://github.com/vsrc/samg
- Owner: vsrc
- License: mit
- Created: 2021-02-19T18:00:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-17T02:44:12.000Z (about 4 years ago)
- Last Synced: 2025-02-16T10:42:52.457Z (over 1 year ago)
- Language: Go
- Size: 30.3 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SAM Generator
AWS SAM boilerplate generator command line utility
Motivation behind creating this tool is to help automate repetitive steps a developer has to do when creating api with AWS lambda. In addition to already existing amazing aws sam cli tools, for each new function and stack, developer needs to:
1. Create new folder/s
2. Copy paste template code
3. Copy paste any commonly used code snippets
4. Add configuration for the new function / stack in `template.yaml`
This tool does all of that for you with one command. Two if you need to create a stack.
## How to install
To install it, run:
```sh
go get github.com/vsrc/samg
```
Command will download and compile the source code, then put it in the `bin` folder inside your `GOPATH`.
### Requirement
In order to properly work this tool requires templates. You can download `templates` folder from from this repo and edit them if needed. These files are generated with aws sam cli sample command `sam init` and contain simple demo functionality.
As you are developing your api, you might start using your own set libraries / packages / code snippets in most of your functions and it makes sense to add them to the template code so it gets copied into every new function you generate afterwards.
## How to use
To see all commands and options available run
```sh
samg -h
```
or for specific command
```sh
samg [COMMAND] -h
```
### To create new stack
```sh
samg stack [command options]
```
Options that you can add to this command:
```txt
--path value, -p value path where new stack will be created (required)
--parent value, -a value path to folder where parent stack configuration file is in which we will put the reference to this new stack (default: parent folder of the provided path)
--template value, -t value path to template file for this new stack (default: templates/stack/template.yaml)
--help, -h show help (default: false)
```
For example command:
```sh
samg stack -p v1/
```
will create new folder `v1` and put `template.yaml` file inside, ready to be populated.
NOTE: when deploying via aws sam cli, deployment will create new separate API for each stack. It makes sense to keep same logical units inside same stack.
### To create new function
```sh
samg function [command options]
```
Options that you can add to this command:
```txt
--path value, -p value path where new function will be created (required)
--parent value, -a value path to folder where parent stack configuration file is in which we will put the reference to this new function (default: parent folder of the provided path)
--template value, -t value path to template folder for this new function (default: templates/fn/)
--name value, -n value optional name for this function (default: last part of provided path)
--url value, -u value url for the api for this function (default: same as provided path)
--method value, -m value http method for this function (default: GET)
--help, -h show help (default: false)
```
For example command:
```sh
samg fn -p v1/user/register
```
will create new folder on the path `v1/user/register/` and put two template files (`go.mod` and `main.go`) inside, ready to be used.
## How to test locally
Use aws sam cli as usual, navigate to the function directory and run:
```sh
sam build # Build package before starting local api
```
```sh
sam local start-api # Start local api
```
### How to deploy
Use aws sam cli as usual, navigate to the folder where `template.yaml` is either for function or for stack and run:
```sh
sam deploy --guided --capabilities CAPABILITY_IAM CAPABILITY_AUTO_EXPAND
```
This command will guide you through first time configuration setup and if you choose to save configuration, for every subsequent run of this command you can omit `--guided` flag.
## TODO Whishlist
These are the things I would like to improve this project with. If you want to suggest any other feel free to file an issue or contact me. If you want to improve this code feel free to submit a PR, I will gladly take a look.
- [ ] Switch to go 1.16 and embed default templates into binary itself
- [ ] TESTS!!! 😬😬😬😬😬😬😬😬😬😬😬 (not a single test written yet)
## Additional resoucres
You can find some really good reading materials about best practices of develpment with aws, sam and lambda on the documentation pages of the AWS. Some of them are:
- [Your first steps with SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-getting-started-hello-world.html)
- [Template anatomy - What to write in the template.yaml file](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
- [Best practices for organizing larger serverless applications,](https://aws.amazon.com/blogs/compute/best-practices-for-organizing-larger-serverless-applications/) one of the first concerns for using AWS lambda for development api is that as your api grows, configuration file becames too big to manage, this article explains best practices how to scale your code and keep it managable
- [Announcing nested applications for AWS SAM and the AWS Serverless Application Repository] https://aws.amazon.com/blogs/compute/announcing-nested-applications-for-aws-sam-and-the-aws-serverless-application-repository/
- [Using nested applications](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-nested-applications.html)
[This blog post](https://blog.rowanudell.com/getting-started-with-aws-sam-cli-and-golang/) from [@elrowan](https://twitter.com/elrowan) gives amazing intro and simple theory into whole aws -> lambda -> sam local development setup, definitely worth reading.
## Contact me
If you would like to contact me about this project or anything else feel free to reach me out: [https://veddy.me/](https://veddy.me/)