Skip to content
This repository has been archived by the owner on Aug 16, 2023. It is now read-only.

Latest commit

 

History

History
45 lines (25 loc) · 1.27 KB

README.md

File metadata and controls

45 lines (25 loc) · 1.27 KB
Raw

Graffold

Rails generator for quickly scaffolding out graphql-ruby types for any ActiveRecord.

Installation

Add this line to your application's Gemfile:

gem 'graffold'

And then execute:

$ bundle

Or install it yourself as:

$ gem install graffold

Usage

rails g graffold:graph NAME [NAMESPACE] [options]

Options:

  [--depth=DEPTH]     # How deep to crawl. Pass `0` to generate a single type
  [--verbose]         # Verbose output

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/farism/graffold.

License

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