Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 3.63 KB

README.md

File metadata and controls

83 lines (59 loc) · 3.63 KB
Raw

Algolia for JavaScript

The perfect starting point to integrate Algolia within your JavaScript project

NPM version NPM downloads jsDelivr Downloads License

Documentation • InstantSearch • Community Forum • Stack Overflow • Report a bug • FAQ • Support

✨ Features

  • Thin & minimal low-level HTTP client to interact with Algolia's API
  • Works both on the browser and node.js
  • UMD and ESM compatible, you can use it with any module loader
  • Built with TypeScript

💡 Getting Started

To get started, you first need to install algoliasearch (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments.

With a package manager

yarn add [email protected]
# or
npm install [email protected]
# or
pnpm add [email protected]

Without a package manager

Add the following JavaScript snippet to the of your website:

// for the full client
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/algoliasearch.umd.js"></script>

// for the lite client
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/lite/builds/browser.umd.js"></script>

Usage

You can now import the Algolia API client in your project and play with it.

import { algoliasearch } from 'algoliasearch';

const client = algoliasearch('YOUR_APP_ID', 'YOUR_API_KEY');

// or with the lite client
import { liteClient } from 'algoliasearch/lite';

const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');

For full documentation, visit the Algolia JavaScript API Client.

❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue

📄 License

The Algolia JavaScript API Client is an open-sourced software licensed under the MIT license.