Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rails-lambda/lamby-cookiecutter

πŸ‘πŸ›€ AWS SAM Cookiecutter to Quick Start Rails & Lambda
https://github.com/rails-lambda/lamby-cookiecutter

aws-lambda aws-sam aws-sam-cookiecutter cookiecutter-template rails ruby-on-rails

Last synced: 11 days ago
JSON representation

πŸ‘πŸ›€ AWS SAM Cookiecutter to Quick Start Rails & Lambda

Awesome Lists containing this project

README

        

# Lamby Cookiecutter

Lamby: Simple Rails & AWS Lambda Integration using Rack.

A [cookiecutter](https://github.com/cookiecutter/cookiecutter) project template to quickly create a new Rails application for AWS Lambda. Details:

- Rails v7.x on Ruby 3.2 runtime.
- Integrated JavaScript & CSS Development.
- CI/CD GitHub Actions for Test & Deploy.

**[Lamby: Simple Rails & AWS Lambda Integration using Rack.](https://lamby.cloud)**

## Usage

⚠️ Please reference the full [Quick Start](https://lamby.cloud/docs/quick-start) guide on the Lamby site for details. Basic usage requires Docker to be installed to run the Cookiecutter software using the following command.

```shell
$ docker run \
--rm \
--interactive \
--volume "${PWD}:/var/task" \
ghcr.io/rails-lambda/lamby-cookiecutter \
"gh:rails-lambda/lamby-cookiecutter"
```

## Contributing

This project is built for [GitHub Codespcaes](https://github.com/features/codespaces) using the [Development Container](https://containers.dev) specification. Once you have the repo cloned and setup with a dev container using either Codespaces or [VS Code](#using-vs-code), run the following commands. This will install Rails and build the Cookiecutter project with any local changes.

```shell
$ ./bin/build
```

#### Using VS Code

If you have the [Visual Studio Code Dev Container](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension installed you can easily clone this repo locally, use the "Open Folder in Container..." command. This allows you to use the integrated terminal for the command above.

## Code of Conduct

Everyone interacting in the Lamby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rails-lambda/lamby/blob/master/CODE_OF_CONDUCT.md).

Bug reports and pull requests are welcome on GitHub at https://github.com/rails-lambda/lamby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.