goskeleton

command module
v0.0.0-...-bbdf639 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 28, 2024 License: GPL-3.0 Imports: 15 Imported by: 0

README

goskeleton

Maintained by Skyhawk Security Maintenance Contributor covenant

GitHub go.mod Go version Go Report Card Go Doc

GitHub Actions Workflow Status GitHub commit activity

GoSkeleton

GoSkeleton is a project aimed at creating skeleton services for easier and quicker onboarding to both the projects and the Golang language itself. The projects that are generated are built with Clean Architecture and support both native (docker, ec2, etc.) and lambda deployments.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to goskeleton@skyhawk.security.

Installation

# clone && cd into the repository
go install

Key Features

  • Clean Architecture generated code, structured and implemented: Focus on your business logic and avoid distractions.

  • Have a full Golang experience: The directory structure, generated code and intensive use standard library and Golang's best practices provide a minimalistic, lean and Go-ish experience.

  • Multi-platform support: AWS Lambda and Native (Docker, EC2, etc) deployments are available out of the box.

  • OpenAPI 3.x code generation and validation: Write your OpenAPI spec and let us do the REST. Avoid writing boilerplate code but still have control over what's going on.

Usage Examples

For a web server Lambda
goskeleton web-service --serviceName mycoolwebservice --destination $HOME/Desktop
For an event driven Lambda
goskeleton event-driven --event-source SQS --event-source-arn arn:aws:sqs:us-east-1:123456789012:example-sqs-queue-name --serviceName mycooledsservice --destination $HOME/Desktop

Discussion

Have a question? Post it in goskeleton GitHub Discussions

Contributing to the project

Want to contribute? Please read the Contribution Guide

License

GPL-3.0

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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