Project

svrless

0.0
The project is in a healthy, maintained state
Bridging the gap between monolithic style development with a serverless backend.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Project Readme

SVRLESS

Serverless framework for Rails developers. Very much still in very early development. A roadmap will be published soon.

Required

AWS SAM CLI is required to build and deploy the templates generated by this gem.

Installation

Add this line to your application's Gemfile:

gem 'svrless'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install svrless

Usage

TODO: Write usage instructions here

To create a new svrless project

$ mkdir  your-project-dir

$ cd your-project-dir

$ svrless

# uncomment the resources in routes

$ ruby config/routes.rb 

$ bundle install

$ sam build

$ sam local start-api

$ make a POST request to http://localhost:3000/posts to see your lambda in action

Routes

The routes file accepts a list of resources in their singular form i.e

resources :post, :comment, :user

This will create controllers for those resources with routing mechanics in the SAM validated template.yaml.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/svrless.

License

The gem is available as open source under the terms of the MIT License.