rainbow

module

v0.0.1 Latest Latest Go to latest Published: Feb 4, 2024 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nao1215/rainbow

Links

Open Source Insights

README ¶

Coverage

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	✅	100%	User-friendly s3 management tool
spare	✅	50%	Single Page Application Release Easily
cfn	✅	0%	List up or delete CloudFormation stacks

s3hub example

The s3hub command provides following features:

Create a S3 bucket
List S3 buckets
List S3 objects in the S3 bucket
Copy files to S3 bucket
Delete contents from the S3 bucket
Delete the S3 bucket
Interactive mode

interactive_mode

Template List

[WIP]

LICENSE

This project is licensed under the terms of the MIT license. See the LICENSE file.

Contributing

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

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

GitHub Star History

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

Unit Test Coverage Treemap

Coverage Treemap

Special Thanks

LocalStack 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):

_{CHIKAMATSU Naohiro}
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
app
di
domain Package domain implements the domain layer.	Package domain implements the domain layer.
domain/model Package model contains the definitions of domain models and business logic.	Package model contains the definitions of domain models and business logic.
domain/service Package service implements the service layer.	Package service implements the service layer.
external Package external implements the external service.	Package external implements the external service.
external/mock
interactor Package interactor contains the implementations of usecases.	Package interactor contains the implementations of usecases.
interactor/mock
usecase Package usecase has interfaces that wrap the basic business logic.	Package usecase has interfaces that wrap the basic business logic.
cmd
cfn Package main is the entrypoint of s3hub.	Package main is the entrypoint of s3hub.
s3hub Package main is the entrypoint of s3hub.	Package main is the entrypoint of s3hub.
spare Package main is the entrypoint of spare.	Package main is the entrypoint of spare.
subcmd
subcmd/cfn Package cfn is the root command of cfn.	Package cfn is the root command of cfn.
subcmd/s3hub Package s3hub is the root command of s3hub.	Package s3hub is the root command of s3hub.
subcmd/spare Package spare is a package that contains subcommands for the spare CLI command.	Package spare is a package that contains subcommands for the spare CLI command.
config Package config defines the config of rainbow cli.	Package config defines the config of rainbow cli.
s3hub
spare
ui
s3hub Package s3hub is the text-based user interface for s3hub command.	Package s3hub is the text-based user interface for s3hub command.
utils
errfmt Package errfmt format the error message.	Package errfmt format the error message.
file Package file provides functions for file operations.	Package file provides functions for file operations.
xregex Package xregex provides a type that represents a regular expression pattern.	Package xregex provides a type that represents a regular expression pattern.
version Package version provides version information.	Package version provides version information.