https://github.com/benjamincanac/adonis-algoliasearch
AdonisJS provider for Algolia
https://github.com/benjamincanac/adonis-algoliasearch
adonis-algoliasearch adonisjs algolia-search
Last synced: 3 months ago
JSON representation
AdonisJS provider for Algolia
- Host: GitHub
- URL: https://github.com/benjamincanac/adonis-algoliasearch
- Owner: benjamincanac
- License: mit
- Created: 2018-10-01T11:36:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T12:17:13.000Z (over 3 years ago)
- Last Synced: 2025-02-28T23:26:50.991Z (4 months ago)
- Topics: adonis-algoliasearch, adonisjs, algolia-search
- Language: JavaScript
- Homepage: https://github.com/algolia/algoliasearch-client-javascript
- Size: 167 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Adonis AlgoliaSearch
> This package is a wrapper on top of [algoliasearch-client-javascript](https://github.com/algolia/algoliasearch-client-javascript).
[](https://www.npmjs.com/package/adonis-algoliasearch)
[](https://github.com/cmty/adonis-algoliasearch/blob/master/LICENSE.md)
## Getting Started
Install the package using the `adonis` CLI.
```bash
> adonis install adonis-algoliasearch
```
Follow instructions that are displayed ([or read them here](https://github.com/cmty/adonis-algoliasearch/blob/master/instructions.md)).
## Configure
Register the provider in `start/app.js`:
```javascript
const providers = [
...
'adonis-algoliasearch/providers/AlgoliaSearchProvider'
]
```
Add a configuration file in `config/algolia.js`. For example:
```javascript
'use strict'
const Env = use('Env')
module.exports = {
id: Env.get('ALGOLIA_APP_ID'),
index: Env.get('ALGOLIA_APP_INDEX'),
apiKey: Env.get('ALGOLIA_API_KEY')
}
```
## Usage
```javascript
const AlgoliaSearch = use('AlgoliaSearch')
const index = AlgoliaSearch.index('projects')
```
The index returned is the `client.initIndex` of `algoliasearch`, you have then access to all methods.
## Thanks
Special thanks to the creator(s) of [AdonisJS](http://adonisjs.com/) for creating such a great framework.
## License
[MIT](https://github.com/cmty/adonis-algoliasearch/blob/master/LICENSE.md)