https://github.com/xiewenwei/grpc_for_rails
Make grpc server and client easy for rails project.
https://github.com/xiewenwei/grpc_for_rails
grpc grpc-ruby grpc-server rails
Last synced: 8 months ago
JSON representation
Make grpc server and client easy for rails project.
- Host: GitHub
- URL: https://github.com/xiewenwei/grpc_for_rails
- Owner: xiewenwei
- License: mit
- Created: 2017-12-22T06:08:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-05T08:39:52.000Z (over 8 years ago)
- Last Synced: 2025-10-07T19:22:05.275Z (8 months ago)
- Topics: grpc, grpc-ruby, grpc-server, rails
- Language: Ruby
- Homepage:
- Size: 35.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GrpcForRails
Make grpc server and client easy for rails project.
grpc_for_rails provides a useful grpc_server wrapper and some flexible generators and rake tasks for rails project.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'grpc_for_rails'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install grpc_for_rails
Run grpc:install generator after install gem:
$ bin/rails g grpc:install
## Usage
Start grpc_server and daemonize it:
$ bundle exec grpc_server -p grpc_server.pid -d
Stop grpc_server:
$ kill -TERM `cat grpc_server.pid`
Generate grpc_server configuration scaffold:
$ bin/rails g grpc:install
It will generate folder `/app/grpc` and sub-folder [`base`, `protos`, `services`] which are the default location for `grpc_for_rails`
And it will generate file `/config/grpc_server.yml` which includes all grpc_server configurations `grpc_for_rails` supported. You can change it for your need.
Generate grpc_server service scaffold (TODO):
$ bin/rails g grpc:service
Generate grpc_server services ruby codes for grpc proto files:
$ bin/rails g grpc:base
It will generate ruby codes based on grpc proto files in `/app/grpc/protos`.
## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/xiewenwei/grpc_for_rails. 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.
## Code of Conduct
Everyone interacting in the GrpcForRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/xiewenwei/grpc_for_rails/blob/master/CODE_OF_CONDUCT.md).