The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content

Setup repository

info

Make sure to have Docker installed so you don’t have to install the tooling for every API clients. Installation guide

Install the dependencies​

nvm use && yarn

Mounting the docker images​

yarn docker:setup

Docker​

Build​

We use 1 docker image per language to simplify the build, and reuse them on the CI. There is one base image containing node, java, scala and kotlin, located in scripts/docker/Dockerfile

yarn docker:setup
caution

The swift images takes a really long time to build (~5 minutes) because of swift-format, but it’s only needed when you want to format swift.

Tooling​

Install the CLI tool by following the instructions at the top of scripts/install.sh to acces apic from your terminal, with bash autocompletion. You can run apic help to check if it’s working properly.

Clean​

Stops all containers and clean the images

docker compose down --rmi all

Contribute​

Once you’ve successfully built and mounted the Docker image, you can now play with the repository! Read our guides on:

Troubleshooting​

caution

You should run the commands via the Docker container to avoid issues.

Error: The operation couldn't be completed. Unable to locate a Java Runtime.

Java is not located in your PATH, either source the right .bash_profile, .zshrc, etc. file or do the following command in this repository:

echo 'export PATH="/usr/local/opt/openjdk/bin:$PATH"' > .bash_profile && source .bash_profile

Running renovate locally​

Running renovate on github can be tidious because it only works on the branch main, but you can run it locally with the CLI:

npm install -g renovate

LOG_LEVEL=debug renovate --dry-run --platform local