ruby

May 15, 2024

c75373b · May 15, 2024

Name	Name	Last commit message	Last commit date
parent directory ..
.devcontainer	.devcontainer	Add Ruby Quickstart	Oct 4, 2021
.env.example	.env.example	script for exporting, creating and modifying rules created	Apr 11, 2024
Gemfile	Gemfile	Add Ruby Quickstart	Oct 4, 2021
Gemfile.lock	Gemfile.lock	script for exporting, creating and modifying rules created	Apr 11, 2024
README.md	README.md	fix(README): Fix signup link	Oct 20, 2021
backup_index.rb	backup_index.rb	created backup index file	May 15, 2024
export_and_add_rule_to_index.rb	export_and_add_rule_to_index.rb	create add export rule ruby (#45 )	Mar 23, 2023
generate_key.rb	generate_key.rb	ruby script to create a search only rate limited api key	Nov 23, 2022
index_settings.rb	index_settings.rb	feat: adding indexing script	Feb 17, 2022
indexing.rb	indexing.rb	Add Ruby Quickstart	Oct 4, 2021
rules.rb	rules.rb	script for exporting, creating and modifying rules created	Apr 11, 2024
simple.rb	simple.rb	fix: update comment strings	Oct 12, 2021

README.md

This quickstart demonstrates various usages of the the Algolia Ruby API Client.

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_KEY and ALGOLIA_INDEX_NAME in the .env file. You can obtain those from the Algolia Dashboard. The ALGOLIA_API_KEY should be the "Admin API Key" (necessary for indexing).

Once setup, you can run each of the script in this folder using the PHP command line. Example: to execute the simple.rb script:

ruby simple.rb

File	Description
simple.rb	Index a single object and run a search query
indexing.rb	Showcase of the main indexing methods