Skip to main content

Setup the repository tooling

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

Install the dependencies​

nvm use && yarn

Mounting the docker image​

You can also execute docker commands one by one, see Docker commands

yarn docker:setup

Docker​

Build​

Build docker image from Dockerfile

How to add a new client | How to add a new language | Common Test Suite | Run the playground

yarn docker:build

Mount​

Mount docker image on dev container

yarn docker:mount

Clean​

Stops dev container and clean the built image

yarn docker:clean

Troubleshooting​

caution

You should run the commands via the Docker container to avoid Java 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