100 lines
5.7 KiB
Markdown
100 lines
5.7 KiB
Markdown
# 
|
||
|
||
[](https://github.com/activerecord-hackery/ransack/actions)
|
||
[](http://badge.fury.io/rb/ransack)
|
||
[](https://codeclimate.com/github/activerecord-hackery/ransack)
|
||
[](#backers) [](#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
|
||
|
||
```ruby title='Gemfile'
|
||
gem 'ransack'
|
||
```
|
||
|
||
### Bleeding edge
|
||
|
||
If you would like to use the latest updates not yet published to RubyGems, use the `main` branch:
|
||
|
||
```ruby 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](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 or [GitHub Discussions](https://github.com/activerecord-hackery/ransack/discussions) 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](CONTRIBUTING.md).
|
||
* Please use Stack Overflow or [GitHub Discussions](https://github.com/activerecord-hackery/ransack/discussions) for questions or discussion not
|
||
directly related to bug reports, pull requests, or documentation improvements.
|
||
* Spread the word on social media 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. <img src="https://opencollective.com/ransack/contributors.svg?width=890&button=false" />
|
||
|
||
|
||
## Backers
|
||
|
||
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/ransack#backer)]
|
||
|
||
<a href="https://opencollective.com/ransack#backers" target="_blank"><img src="https://opencollective.com/ransack/backers.svg?width=890" /></a>
|
||
|
||
|
||
## 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)]
|
||
|
||
<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>
|