Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elsoul/souls
🕺 SOULs 💃 Build Serverless Apps faster like Rails. Powered by Ruby GraphQL, Active Record, RSpec, RuboCop, and Google Cloud.
https://github.com/elsoul/souls
active-record api cloud-native framework google-cloud google-cloud-run graphql graphql-api nat pubsub rails rspec rubocop ruby ruby-on-rails serverless serverless-framework worker
Last synced: 22 days ago
JSON representation
🕺 SOULs 💃 Build Serverless Apps faster like Rails. Powered by Ruby GraphQL, Active Record, RSpec, RuboCop, and Google Cloud.
- Host: GitHub
- URL: https://github.com/elsoul/souls
- Owner: elsoul
- License: apache-2.0
- Created: 2020-10-27T17:12:55.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-25T15:53:47.000Z (about 2 years ago)
- Last Synced: 2024-09-30T07:02:18.169Z (about 1 month ago)
- Topics: active-record, api, cloud-native, framework, google-cloud, google-cloud-run, graphql, graphql-api, nat, pubsub, rails, rspec, rubocop, ruby, ruby-on-rails, serverless, serverless-framework, worker
- Language: Ruby
- Homepage: https://souls.el-soul.com
- Size: 2.89 MB
- Stars: 332
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://souls.elsoul.nl)
## Ruby Serverless Application Framework SOULs Document
- [Go to SOULs Document](https://souls.elsoul.nl/)
## 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](https://cloud.google.com/sdk/docs)
- [Docker](https://www.docker.com/)
- [Firebase CLI](https://firebase.google.com/docs/cli)
- [Ruby](https://www.ruby-lang.org)
- [Github CLI](https://cli.github.com/)
## Cloud Infrastructure
- [Google Cloud Run](https://cloud.google.com/run)
- [Google Cloud Functions](https://cloud.google.com/functions)
- [Google Cloud SQL](https://cloud.google.com/sql)
- [Google Cloud Pub/Sub](https://cloud.google.com/pubsub)
- [Google Cloud Storage](https://cloud.google.com/run)
- [Google Cloud IAM](https://cloud.google.com/iam)
- [Google Cloud Container Registry](https://cloud.google.com/container-registry)
- [Google Firebase](https://firebase.google.com/)
- [Google Cloud Scheduler](https://cloud.google.com/scheduler)
- [Google Cloud VPC](https://cloud.google.com/vpc)
- [Google Cloud Nat](https://cloud.google.com/nat)
- [Github Actions](https://github.com/features/actions)
## Installation
Add this line to your application's Gemfile:
```ruby
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](https://rubygems.org/gems/souls).
## Test Coverage
[Rspec Test Coverage](https://storage.googleapis.com/souls-bucket/souls-coverage/index.html#_AllFiles)
## 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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
## 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](https://github.com/elsoul/souls/blob/master/CODE_OF_CONDUCT.md).