Project

souls

0.0
The project is in a healthy, maintained state
SOULS is a Web Application Framework for Microservices on Google Cloud Platform.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
 Project Readme

SOULs


What's SOULs?

Welcome to SOULs Framework!

SOULs is a Web Application Framework for Microservices on Google Cloud Platform.

SOULs creates 4 types of framework.

  1. Service - gRPC Serverless Scalable Service (Ruby)
  2. API - GraphQL to call gRPC (Ruby)
  3. Media Web Client - Media web client with SSG (TypeScript)
  4. Admin Web Client - Admin Console and CMS (TypeScript)

Dependency

Cloud Infrastructure

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

Choose SOULs Type:

  1. Service
  2. API
  3. Media Web
  4. Admin Web

Usage

Version Check

$ souls -v

Init Proto Files

$ souls p `service_name`

Run Server

$ souls s

Run Console

$ souls c

Run Infra Command

$ souls i `method_name`

Deploy

$ souls i deploy

※Only Initial

Update

$ souls i update

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 tags, and push the .gem file to rubygems.org.

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 HotelPrice project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.