2022-03-30 22:08:24 +00:00
# ![Ransack](./docs/static/logo/ransack-h.png "Ransack")
2011-06-07 01:32:03 +00:00
2020-12-01 13:28:19 +00:00
[![Build Status ](https://github.com/activerecord-hackery/ransack/workflows/test/badge.svg )](https://github.com/activerecord-hackery/ransack/actions)
2017-06-21 04:25:50 +00:00
[![Gem Version ](https://badge.fury.io/rb/ransack.svg )](http://badge.fury.io/rb/ransack)
[![Code Climate ](https://codeclimate.com/github/activerecord-hackery/ransack/badges/gpa.svg )](https://codeclimate.com/github/activerecord-hackery/ransack)
2019-08-19 01:19:59 +00:00
[![Backers on Open Collective ](https://opencollective.com/ransack/backers/badge.svg )](#backers) [![Sponsors on Open Collective ](https://opencollective.com/ransack/sponsors/badge.svg )](#sponsors)
2014-04-24 07:14:51 +00:00
2022-03-30 22:08:24 +00:00
# SPECIAL ANNOUNCEMENT
Please see the [Ransack Blog ](https://activerecord-hackery.github.io/ransack/blog ) for a special announcement from the Ransack maintainers and Ernie Miller, the original author of Ransack.
2011-06-07 01:32:03 +00:00
2022-03-30 21:53:06 +00:00
# Introduction
2011-06-07 01:32:03 +00:00
2022-03-30 21:53:06 +00:00
Ransack will help you easily add **searching to your Rails application** , without any additional dependencies.
2015-12-20 01:23:02 +00:00
2022-03-30 21:53:06 +00:00
There are advanced searching solutions around, like ElasticSearch or Algolia. **Ransack** will do the job for many Rails websites, without the need to run additional infrastructure or work in a different language. With Ransack you do it all with standard Ruby and ERB.
2015-12-20 01:23:02 +00:00
2022-03-30 21:53:06 +00:00
Ready to move beyond the basics? Use **advanced features** like i18n and extensive configuration options.
2015-12-20 01:23:02 +00:00
2022-03-30 21:53:06 +00:00
Ransack is supported for Rails 7.0, 6.x on Ruby 2.6.6 and later.
2014-09-05 23:18:03 +00:00
2022-03-30 21:53:06 +00:00
## Installation
2014-09-05 23:18:03 +00:00
2022-03-30 21:53:06 +00:00
To install `ransack` and add it to your Gemfile, run
2014-09-05 23:18:03 +00:00
2022-03-30 21:53:06 +00:00
```jsx title='Gemfile'
gem 'ransack'
2014-09-05 23:18:03 +00:00
```
2022-03-30 21:53:06 +00:00
### Bleeding edge
2013-10-07 11:47:52 +00:00
2022-03-30 21:53:06 +00:00
If you would like to use the latest updates not yet published to RubyGems, use the `main` branch:
2012-10-06 21:14:47 +00:00
2022-03-30 21:53:06 +00:00
```jsx title='Gemfile'
gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'main'
2014-10-22 21:41:58 +00:00
```
2022-03-30 21:53:06 +00:00
### Documentation
2020-12-13 17:02:57 +00:00
2022-03-30 21:53:06 +00:00
There is [extensive documentation on Ransack ](https://activerecord-hackery.github.io/ransack/ ), which is a [Docusaurus ](https://docusaurus.io/ ) project and run as a GitHub Pages site.
2014-11-04 00:45:12 +00:00
2022-03-30 21:53:06 +00:00
## Issues tracker
2014-11-04 20:25:57 +00:00
2022-03-30 21:53:06 +00:00
* Before filing an issue, please read the [Contributing Guide ](https://github.com/activerecord-hackery/ransack/CONTRIBUTING.md ).
* File an issue if a bug is caused by Ransack, is new (has not already been reported), and _can be reproduced from the information you provide_ .
* Please consider adding a branch with a failing spec describing the problem.
* Contributions are welcome. :smiley:
* Please do not use the issue tracker for personal support requests. Stack Overflow is a better place for that where a wider community can help you!
2014-10-26 22:21:01 +00:00
2011-06-07 01:32:03 +00:00
## Contributions
2012-03-29 14:50:36 +00:00
To support the project:
2011-06-07 01:32:03 +00:00
2022-03-30 21:53:06 +00:00
* Consider supporting us via [Open Collective ](https://opencollective.com/ransack/backers/badge.svg )
2014-05-11 15:10:08 +00:00
* Use Ransack in your apps, and let us know if you encounter anything that's
2014-10-14 20:17:30 +00:00
broken or missing. A failing spec to demonstrate the issue is awesome. A pull
request with passing tests is even better!
* Before filing an issue or pull request, be sure to read and follow the
2022-03-30 21:53:06 +00:00
[Contributing Guide ](https://github.com/activerecord-hackery/ransack/CONTRIBUTING.md ).
2014-10-14 20:17:30 +00:00
* Please use Stack Overflow or other sites for questions or discussion not
directly related to bug reports, pull requests, or documentation improvements.
2014-05-11 15:10:08 +00:00
* Spread the word on Twitter, Facebook, and elsewhere if Ransack's been useful
to you. The more people who are using the project, the quicker we can find and
fix bugs!
2018-11-03 19:28:50 +00:00
## Contributors
2022-03-30 21:53:06 +00:00
Ransack was created by [Ernie Miller ](http://twitter.com/erniemiller ) and is developed and maintained by:
* [Sean Carroll ](https://github.com/scarroll32 )
* [Deivid Rodriguez ](https://github.com/deivid-rodriguez )
* [Greg Molnar ](https://github.com/gregmolnar )
* [A great group of contributors ](https://github.com/activerecord-hackery/ransack/graphs/contributors ).
- Ransack's logo is designed by [Anı l Kı lı ç ](https://github.com/anilkilic ).
2020-01-10 23:54:38 +00:00
2022-03-30 21:53:06 +00:00
Alumni Maintainers
2020-01-10 23:54:38 +00:00
- [Jon Atack ](http://twitter.com/jonatack )
- [Ryan Bigg ](http://twitter.com/ryanbigg )
2022-03-30 21:53:06 +00:00
This project exists thanks to all the people who contribute. < img src = "https://opencollective.com/ransack/contributors.svg?width=890&button=false" / >
2020-01-10 23:54:38 +00:00
2018-11-03 19:28:50 +00:00
## Backers
Thank you to all our backers! 🙏 [[Become a backer ](https://opencollective.com/ransack#backer )]
2022-03-30 21:53:06 +00:00
< a href = "https://opencollective.com/ransack#backers" target = "_blank" > < img src = "https://opencollective.com/ransack/backers.svg?width=890" / > < / a >
2018-11-03 19:28:50 +00:00
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor ](https://opencollective.com/ransack#sponsor )]
2022-03-30 21:53:06 +00:00
< a href = "https://opencollective.com/ransack/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/0/avatar.svg" / > < / a >
< a href = "https://opencollective.com/ransack/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/1/avatar.svg" / > < / a >
< a href = "https://opencollective.com/ransack/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/2/avatar.svg" / > < / a >
< a href = "https://opencollective.com/ransack/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/3/avatar.svg" / > < / a >
< a href = "https://opencollective.com/ransack/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/4/avatar.svg" / > < / a >
< a href = "https://opencollective.com/ransack/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/5/avatar.svg" / > < / a >
< a href = "https://opencollective.com/ransack/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/6/avatar.svg" / > < / a >
< a href = "https://opencollective.com/ransack/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/7/avatar.svg" / > < / a >
< a href = "https://opencollective.com/ransack/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/8/avatar.svg" / > < / a >
< a href = "https://opencollective.com/ransack/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/ransack/sponsor/9/avatar.svg" / > < / a >