Local development

If you would like to set up a development environment on your own machine to work on wanderer please first follow the bare-metal installation steps in the installation guide. We will slightly modify the launch script to launch a node server in development mode instead:

trap "kill 0" EXIT

export ORIGIN=http://localhost:5173
export MEILI_URL=http://127.0.0.1:7700
export MEILI_MASTER_KEY=p2gYZAWODOrwTPr4AYoahCZ9CI8y9bUd0yQLGk-E3m8
export PUBLIC_POCKETBASE_URL=http://127.0.0.1:8090
export PUBLIC_VALHALLA_URL=https://valhalla1.openstreetmap.de

cd search && ./meilisearch --master-key $MEILI_MASTER_KEY &
cd db && ./pocketbase serve &
cd web && npm run dev &

wait

This will bring up a meilisearch instance on http://127.0.0.1:7700, a PocketBase instance on http://127.0.0.1:8090, and a vite server for the wanderer frontend on http://localhost:5173.

Accessing the backend

Sometimes it can be useful to edit data directly in the database. PocketBase offers a convenient web UI to do so. Simply head over to http://127.0.0.1:8090/_/. If you access the admin panel for the first time you will be asked to create an admin account. Afterwards, you can create, read, update, and delete data in the respective tables. To learn more about PocketBase you can head over to their extensive documentation.

Building

When you are done with development and would like to build wanderer for production there are some steps to follow.

meilisearch

If you modified any attributes of one of the meilisearch indices (like filterable attributes), you will need to create a new dump that gets imported into wanderer on launch. To do so run

curl -X POST 'http://127.0.0.1:7700/dumps'

and overwrite the previous dump at /search/migrations/migration.dump with your updated one.

PocketBase

If you modified code in any of the *.go files make sure to build an updated binary with go build. In case you only edited tables via the PocketBase admin panel you don’t need to do anything. The database will be migrated automatically.

Frontend

For the frontend there are no further caveats. Simply run npm run build.

Docker

To create local docker images of wanderer simply run the script below. These will work as drop-in replacements for the ones hosted on docker hub. This will only work if you have already completed the steps above.

# search
docker build search/ --no-cache -t flomp/wanderer-search:latest

# db
docker build db/ --no-cache -t flomp/wanderer-db:latest

# web
docker build web/ --no-cache  -t flomp/wanderer-web:latest