# ![Ransack](./docs-website/static/logo/ransack-h.png "Ransack") [![Build Status](https://github.com/activerecord-hackery/ransack/workflows/test/badge.svg)](https://github.com/activerecord-hackery/ransack/actions) [![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) [![Backers on Open Collective](https://opencollective.com/ransack/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/ransack/sponsors/badge.svg)](#sponsors) # Introduction Ransack will help you easily add **searching to your Rails application**, without any additional dependencies. 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. Ready to move beyond the basics? Use **advanced features** like i18n and extensive configuration options. Ransack is supported for Rails 7.0, 6.x on Ruby 2.6.6 and later. ## Installation To install `ransack` and add it to your Gemfile, run ```jsx title='Gemfile' gem 'ransack' ``` ### Bleeding edge If you would like to use the latest updates not yet published to RubyGems, use the `main` branch: ```jsx title='Gemfile' gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'main' ``` ### Documentation 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. ## Issues tracker * 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! ## Contributions To support the project: * Consider supporting us via [Open Collective](https://opencollective.com/ransack/backers/badge.svg) * Use Ransack in your apps, and let us know if you encounter anything that's 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 [Contributing Guide](https://github.com/activerecord-hackery/ransack/CONTRIBUTING.md). * Please use Stack Overflow or other sites for questions or discussion not directly related to bug reports, pull requests, or documentation improvements. * 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! ## Contributors 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). Alumni Maintainers - [Jon Atack](http://twitter.com/jonatack) - [Ryan Bigg](http://twitter.com/ryanbigg) This project exists thanks to all the people who contribute. ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/ransack#backer)] ## 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)]