Quickstart guide#

This is the quick start guide for setting up and running the frontend locally.


Refer to the general setup guide for setting up the prerequisites. Refer to the ‘Frontend’ column in the requirement matrix to know what you need to run this.

Starting up#

  1. Ensure you download, install and set up all prerequisites. Ensure that the Docker daemon is running.

  2. Clone the repository to your computer. Then switch to the cloned directory. If you’re planning to contribute, fork the repo and clone your fork instead.

    $ git clone https://github.com/WordPress/openverse.git # or your fork
    $ cd openverse/

    If you followed the general setup guide and installed GitHub CLI, you can clone more simply using the gh command.

    $ gh repo clone WordPress/openverse # or your fork
    $ cd openverse/
  3. Install only the Node.js dependencies. You do not need to install any Python dependencies to run the frontend.

    $ just node-install
  4. To bring up the frontend, we have another just recipe. We have just recipes for almost everything.

    $ just frontend/run dev

    If you want your frontend to use a different API instance, you can set the API_URL environment variable to point to that instance. If you had the API running locally, you can do the following to use the local API with the frontend.

    $ env API_URL="http://localhost:50280" just frontend/run dev

    Now you should be able to access the following endpoints:

Shutting down#

You can press Ctrl + C to terminate the frontend process.