https://github.com/evokelektrique/wordpress-meilisearch

https://github.com/evokelektrique/wordpress-meilisearch

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/evokelektrique/wordpress-meilisearch
• Owner: evokelektrique
• Created: 2023-08-24T19:29:48.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-26T12:01:45.000Z (about 1 year ago)
• Last Synced: 2023-08-26T12:47:22.825Z (about 1 year ago)
• Language: PHP
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# WordPress MeiliSearch Plugin

Enhance WordPress search using MeiliSearch for lightning-fast and accurate results.

## Table of Contents

- [Description](#description)

- [Features](#features)

- [Installation](#installation)

- [Usage](#usage)

- [Configuration](#configuration)

- [Contributing](#contributing)

- [License](#license)

## Description

The WordPress MeiliSearch Plugin integrates the powerful MeiliSearch search engine into your WordPress website, enabling faster and more accurate search results for your users. This plugin offers seamless synchronization between your WordPress posts and the MeiliSearch index, ensuring up-to-date search results.

## Features

- Lightning-fast search results powered by MeiliSearch.

- Automated synchronization of WordPress posts with MeiliSearch index.

- Customizable search experience with instant results.

- Easily configurable settings for API keys, host, port, and index name.

- Background jobs for post synchronization and index management.

## Installation

1. Clone or download the repository to your WordPress plugins directory.

2. Run `composer install` to install the required PHP dependencies.

3. Activate the plugin via the WordPress admin panel.

## Usage

1. Access the plugin settings in the WordPress admin panel.

2. Configure the MeiliSearch API keys, host, port, and index name.

3. Use the "Synchronize Posts" button to initiate background post synchronization.

4. Enjoy lightning-fast and accurate search results on your WordPress site.

## Configuration

To configure the plugin, navigate to the WordPress admin panel and go to **Settings** > **MeiliSearch**. Here you can set the following options:

- **Public API Key**: Your MeiliSearch public API key.

- **Master API Key**: Your MeiliSearch master API key.

- **Host**: The host address of your MeiliSearch server.

- **Port**: The port number used by your MeiliSearch server.

- **Index Name**: The name of the MeiliSearch index for WordPress posts.

## Contributing

Contributions are welcome! To contribute to the WordPress MeiliSearch Plugin, follow these steps:

1. Fork the repository.

2. Create a new branch for your feature or bug fix.

3. Make your changes and submit a pull request.

## License

This plugin is released under the MIT License. See [LICENSE](LICENSE) for more information.