WordPress / openverse-api

The Openverse API allows programmatic access to search for CC-licensed and public domain digital media.
https://api.openverse.engineering/v1
MIT License
76 stars 50 forks source link

Add `coreutils` to pre-requisites (specifically for macOS) #1061

Closed dhruvkb closed 1 year ago

dhruvkb commented 1 year ago

We use the timeout command used to wait for the containers to spin up and be healthy and for various requests to the ingestion server to complete.

The timeout command needs to be installed on macOS systems. Installing the coreutils package adds a bunch of GNU utils to macOS including timeout. This info should be added to the pre-requisites section of the docs.

https://github.com/WordPress/openverse-api/blob/7f88fce11477d135fc349f2352de491a5ee910f8/api/docs/guides/quickstart.md?plain=1#L3