This quickstart demonstrates various usages of the Algolia Java API Client.
- An Algolia account. If you don't have one already, create an account for free.
- A Java local environment, or Docker.
Using VSCode
By using VScode and having the Visual Studio Code Remote - Containers extension installed, you can run any of the quickstarts by using the command Remote-Containers: Open Folder in Container command.
Each of the quickstart contains a .devcontainer.json, along with a Dockerfile.
- Create an Algolia Application and an Algolia Index
- Copy the file .env.example and rename it to
.env - Set the environment variables
ALGOLIA_APP_ID,ALGOLIA_API_KEYandALGOLIA_INDEX_NAMEin the.envfile. You can obtain those from the Algolia Dashboard. TheALGOLIA_API_KEYshould be the "Admin API Key" (necessary for indexing).
Once setup, you can run each of the script in this folder using your favorite Java IDE.
| File | Description |
| ---------------------------- | -------------------------------------------- |
| Simple.java | Index a single object and run a search query |
| Indexing.java | Showcase of the main indexing methods |