kotovalexarian-likes-github/activerecord-hackery--ransack

mirror of https://github.com/activerecord-hackery/ransack.git synced 2022-11-09 13:47:45 -05:00

Object-based searching.

activerecord rails ruby ruby-gem ruby-library ruby-on-rails search search-interface sql

Find a file

Sean 8af516297b Special announcement		2022-03-31 00:08:24 +02:00
.github	Drop Rails 5.2 support	2022-03-07 14:05:29 +01:00
bug_report_templates	Update templates	2020-12-29 01:28:10 +09:00
docs	Documentation site config	2022-03-30 23:53:06 +02:00
lib	Merge branch 'master' into allow-scopes-with-string-joins	2022-03-28 01:53:27 +02:00
spec	Merge branch 'master' into allow-scopes-with-string-joins	2022-03-28 01:53:27 +02:00
.gitignore	use newer mysql and make 5-2-stable the default	2019-04-14 16:30:07 +02:00
.nojekyll	Documentation site config	2022-03-30 23:53:06 +02:00
.rubocop.yml	Add `Style/RedundantFileExtensionInRequire` cop	2020-12-31 20:17:00 +09:00
CHANGELOG.md	Improve `sort_link` documentation (#1290 )	2022-03-25 10:19:30 +01:00
CONTRIBUTING.md	Drop Rails 5.2 support	2022-03-07 14:05:29 +01:00
Gemfile	Rails default branch name changed from master to main	2021-01-17 09:05:04 +09:00
LICENSE	Initial commit.	2011-03-30 20:31:39 -04:00
Rakefile	move mongoid support to a separate gem	2018-06-25 20:50:14 +02:00
ransack.gemspec	Remove reference to Mongoid	2022-03-30 16:25:03 +02:00
README.md	Special announcement	2022-03-31 00:08:24 +02:00

README.md

SPECIAL ANNOUNCEMENT

Please see the Ransack Blog for a special announcement from the Ransack maintainers and Ernie Miller, the original author of Ransack.

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

gem 'ransack'

Bleeding edge

If you would like to use the latest updates not yet published to RubyGems, use the main branch:

gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'main'

Documentation

There is extensive documentation on Ransack, which is a Docusaurus project and run as a GitHub Pages site.

Issues tracker

Before filing an issue, please read the Contributing Guide.
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. 😃
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
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.
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 and is developed and maintained by:

Ransack's logo is designed by Anıl Kılıç.

Alumni Maintainers

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

README.md Unescape Escape