Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nao1215/rainbow

🌈user-friendly AWS toolset and cloudformation templates
https://github.com/nao1215/rainbow

aws aws-cli aws-s3 aws-sdk cloudformation-template command-line-tool go golang user-friendly

Last synced: 20 days ago
JSON representation

🌈user-friendly AWS toolset and cloudformation templates

Awesome Lists containing this project

README 

        

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)



![Coverage](https://raw.githubusercontent.com/nao1215/octocovs-central-repo/main/badges/nao1215/rainbow/coverage.svg)

[![LinuxUnitTest](https://github.com/nao1215/rainbow/actions/workflows/linux_test.yml/badge.svg)](https://github.com/nao1215/rainbow/actions/workflows/linux_test.yml)

[![reviewdog](https://github.com/nao1215/rainbow/actions/workflows/reviewdog.yml/badge.svg)](https://github.com/nao1215/rainbow/actions/workflows/reviewdog.yml)

[![Gosec](https://github.com/nao1215/rainbow/actions/workflows/security.yml/badge.svg)](https://github.com/nao1215/rainbow/actions/workflows/security.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/nao1215/rainbow)](https://goreportcard.com/report/github.com/nao1215/rainbow)



## rainbow 

> [!IMPORTANT]  

> This project is under development. Do not use it in production environments.



The rainbow project is a toolset for managing AWS resources. This project consists of multiple CLI and CloudFormation templates. **I plan to implement TUI mode (Interactive mode) for all CLI commands.**  

  

This project adopts README-Driven Development. Therefore, while there may be a README, there might not be any code yet. If you have any feedback regarding the README, please write down in the Issues.



## Supported OS & Go version

- Linux

- Go 1.19 or later

  

I plan to support Mac. Until certain features are added, it has been excluded from the scope of unit testing.  



Windows is not supported because the tools used in unit testing do not run in a Windows environment. However, it is expected that some features will function in a Windows environment to some extent.



## CLI List

|Name|README|implementation|Description|

|:--|:--|:--|:--|

|[s3hub](./doc/s3hub/README.md)|✅|100%|User-friendly s3 management tool|

|[spare](./doc/spare/README.md)|✅|50%|Single Page Application Release Easily|

|[cfn](./doc/cfn/README.md)|✅|10%|List up or delete CloudFormation stacks|



### s3hub example

The s3hub command provides following features:

- [x] Create a S3 bucket

- [x] List S3 buckets

- [x] List S3 objects in the S3 bucket

- [x] Copy files to S3 bucket

- [x] Delete contents from the S3 bucket

- [x] Delete the S3 bucket

- [x] Interactive mode

  

![interactive_mode](./doc/img/s3hub-interactive.gif)



### spare example

The 'spare' command makes easily the release of Single Page Applications. Spare constructs the infrastructure on AWS to operate the SPA, and then deploys the SPA (please note that it does not support building the SPA). Developers can inspect the infrastructure as CloudFormation before or after its construction.



The infrastructure for S3 and CloudFront is configured as shown in the diagram when you run the "spare build" command.  



![diagram](doc/img/s3_cloudfront.png)



> [!WARNING]  

> The spare command is deleted from the repository. At the very least, the development priority is low.



### cfn example

The cfn command provides the following features:

- [x] List stacks

- [ ] Delete stacks (Not implemented yet)



![cfn_tui](./doc/cfn/cfn_tui.gif)



## CloudFormation Template List

|Name|README|implementation|

|:--|:--|:--|

|[Lambda batch with EventBridge (CloudWatch Events)](./cloudformation/lambda-batch/README.md)|✅|100%|

|[Lambda with API Gateway](./cloudformation/lambda-with-api-gw/README.md)|✅|100%|

|[Daily Cost Notification](./cloudformation/daily-cost-notification/README.md)|✅|100%|

|[CloudWatch Real User Monitoring (RUM)](./cloudformation/cloudwatch-rum/README.md)|✅|100%|

|[Static Web Application Distribution](./cloudformation/static-web-site-distribution/README.md)|✅|100%|



## LICENSE

This project is licensed under the terms of the MIT license. See the [LICENSE](./LICENSE) file.



## Contributing

Contributions are welcome! Please see the following documents for details:

- [CONTRIBUTING.md](./CONTRIBUTING.md)

- [Code of Conduct](./CODE_OF_CONDUCT.md)

- [Principle](./doc/common/principle.md) 

- [Development Eviorment Setup](./doc/common/developers.md)



This project incurs costs on AWS, and financial support from you would make it easier to maintain the project. If you wish to provide financial support, please do so through [GitHub Sponsors](https://github.com/sponsors/nao1215)



## GitHub Star History

GitHub Star is motivation for me. If you like this project, please star it.

[![Star History Chart](https://api.star-history.com/svg?repos=nao1215/rainbow&type=Date)](https://star-history.com/#nao1215/rainbow&Date)



## Unit Test Coverage Treemap

![Coverage Treemap](./doc/img/cover.svg)



## Special Thanks

![localstack](./doc/img/localstack-readme-banner.svg)

[LocalStack](https://www.localstack.cloud/) is a service that mocks AWS, covering a wide range of AWS services. It is not easy to set up an AWS infrastructure for personal development, but LocalStack has lowered the barrier for server application development.



It has been incredibly helpful for my technical learning, and among the open-source software (OSS) I encountered in 2023, LocalStack is undoubtedly the best tool. I would like to take this opportunity to express my gratitude.



## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



  

    

      CHIKAMATSU Naohiro
CHIKAMATSU Naohiro
💻

    

  



This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!