Git Product home page Git Product logo

elasticpress's Introduction

ElasticPress

A fast and flexible search and query engine for WordPress.

Support Level Tests Status Release Version WordPress tested up to version MIT License

Please note: as of ElasticPress 4.0.0 trunk is the stable branch, built assets were removed from the develop branch, a ZIP with the plugin and its built assets are available on the GitHub Releases page, and will include a build script should you want to build assets from a branch. As such, please ensure you have updated any references you have from master to trunk or to GitHub releases depending on whether you require built assets or not.

Overview

ElasticPress, a fast and flexible search and query engine for WordPress, enables WordPress to find or “query” relevant content extremely fast through a variety of highly customizable features. WordPress out-of-the-box struggles to analyze content relevancy and can be very slow. ElasticPress supercharges your WordPress website making for happier users and administrators. The plugin even contains features for popular plugins.

Documentation

ElasticPress has an in depth documentation site. Visit the docs ☞

ElasticPress FAQs and tutorials can be found on our support site. Visit the support site ☞

Requirements and Compatibility

Requirements

ElasticPress requires these software with the following versions:

Compatibility

The WooCommerce feature is compatible with the last two major versions of the WooCommerce plugin.

Building Assets

Simply downloading the repository files is not enough to have the plugin working, as CSS and JavaScript files are built during the release process. If you want to use a development version of the plugin you will to run:

npm install && npm run build

Node.js (v14) and npm (v8) are required.

React Components

Interested in integrating ElasticPress in your headless WordPress website? Check out ElasticPress React.

Issues

If you identify any errors or have an idea for improving the plugin, please open an issue. We're excited to see what the community thinks of this project, and we would love your input!

Support Level

Active: 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.

Changelog

A complete listing of all notable changes to ElasticPress are documented in CHANGELOG.md.

Upgrade notices

3.5

Search Algorithm Upgrade Notice: Version 3.5 includes a revamp of the search algorithm. This is a backwards compatibility break. If you'd like to revert to the old search algorithm, you can use the following code: add_filter( 'ep_search_algorithm_version', function() { return '3.4'; } );. The new algorithm offers much more relevant search results and removes fuzziness which results in mostly unwanted results for most people. If you are hooking in and modifying the search query directly, it's possible this code might break and you might need to tweak it.

4.0.0

Note that ElasticPress 4.0.0 release removes built assets from the develop branch, replaced master with trunk, added a ZIP with the plugin and its built assets in the GitHub Releases page, and included a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to trunk or to GitHub Releases depending on whether you require built assets or not.

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, CONTRIBUTING.md for details on the process for submitting pull requests to us, and CREDITS.md for a listing of maintainers of, contributors to, and libraries used by ElasticPress.

Like what you see?

elasticpress's People

Contributors

tlovett1 avatar felipeelia avatar rahmon avatar jakept avatar oscarssanchez avatar petenelson avatar cmmarslender avatar dinhtungdu avatar chriswiegman avatar brandwaffle avatar jeffpaul avatar christianc1 avatar mlaroy avatar rebeccahum avatar sc0ttkclark avatar aaronholbrook avatar lukaspawlik avatar tott avatar ritesh-patel avatar ivankristianto avatar burhandodhy avatar eugene-manuilov avatar tuanmh avatar joeyblake avatar kallehauge avatar mustafauysal avatar moraleida avatar dependabot[bot] avatar helen avatar goaround avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.