https://github.com/johnayoung/feathers-algolia

A Feathers service for Algolia
https://github.com/johnayoung/feathers-algolia

Last synced: about 2 months ago
JSON representation

A Feathers service for Algolia

• Host: GitHub
• URL: https://github.com/johnayoung/feathers-algolia
• Owner: johnayoung
• License: mit
• Created: 2019-12-18T02:39:23.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-12T20:53:16.000Z (almost 3 years ago)
• Last Synced: 2024-05-18T21:55:11.216Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 492 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/contributing.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-feathersjs - feathers-algolia - Utilize the [Algolia](https://www.algolia.com/doc) API for implementing advanced search functionality into your FeathersJS application. (Plugins / Search)

README

        
# feathers-algolia

[![Build Status](https://travis-ci.org/feathersjs/plugins.png?branch=master)](https://travis-ci.org/feathersjs/plugins)

> **Unofficial** Feathers plugin service for Algolia

## Installation

```

npm install feathers-algolia --save

```

## Documentation

Please refer to the [Algolia Docs](https://www.algolia.com/doc/api-client/getting-started/install/javascript/?language=javascript) for options that can be passed.

### Available Services

The following services are supported and map to the appropriate Stripe resource:

- `Indexing`

- `ManageIndices`

## Complete Example

Here's an example of a Feathers server that uses `coinapi`.

```js

const feathers = require("@feathersjs/feathers");

const plugin = require("feathers-coinapi");

// Provide Algolia search credentials

const algoliaCredentials = {

    app_id: 'YOUR_APP_ID',

    api_key: 'YOUR_API_KEY'

}

// Initialize the application

const app = feathers();

// Initialize the plugin with your Algolia credentials

app.configure(plugin(algoliaCredentials));

```

## License

Copyright (c) 2019

Licensed under the [MIT license](LICENSE).