elsoul/souls

Ruby Serverless Application Framework SOULs Document

• Go to SOULs Document

What's SOULs?

Ruby Serverless Framework 'SOULs'.

The SOULs project was launched with the goal of reducing software development, operation and maintenance costs.

Build Serverless Apps faster like Rails. Powered by Ruby GraphQL, Active Record, RSpec, RuboCop, and Google Cloud.

• Focus on business logic in serverless environment
• Maximize development efficiency with CI / CD standard schema-driven Scaffold
• Achieve global scale with lower management costs

SOULs creates 3 types of App.

1. API - GraphQL (Ruby) - Simple API - Cloud Run
2. Worker - Google Pub/Sub Messaging Worker API (Ruby) - Cloud Run
3. Functions - Google Cloud Functions

Dependency

• Google SDK
• Docker
• Firebase CLI
• Ruby
• Github CLI

Cloud Infrastructure

• Google Cloud Run
• Google Cloud Functions
• Google Cloud SQL
• Google Cloud Pub/Sub
• Google Cloud Storage
• Google Cloud IAM
• Google Cloud Container Registry
• Google Firebase
• Google Cloud Scheduler
• Google Cloud VPC
• Google Cloud Nat
• Github Actions

Installation

Add this line to your application's Gemfile:

gem 'souls'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install souls

And Create Your APP

$ souls new app_name

Development

After checking out the repo, run bin/setup to install dependencies. Then, run souls t to run the tests. You can also run souls c 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 tags, and push the .gem file to rubygems.org.

Test Coverage

Rspec Test Coverage

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/elsoul/souls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the Apache-2.0 License.

Code of Conduct

Everyone interacting in the SOULs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.