voyager-stats

API exposing public statistics about Voyager

Development

Database

Set up PostgreSQL with default settings:

• Port: 5432
• User: your system user name
• Password: blank
• Database: voyager_public

Alternatively, set the environment variable $DATABASE_URL with postgres://${USER}:${PASS}@${HOST}:${POST}/${DATABASE}.

The Postgres user and database need to exist already, and the user needs full management permissions for the database.

You can also run the following command to set up the PostgreSQL server via Docker:

docker run -d --name voyager-db \
  -e POSTGRES_HOST_AUTH_METHOD=trust \
  -e POSTGRES_USER=$USER \
  -e POSTGRES_DB=voyager_public \
  -p 5432:5432 \
  postgres

Finally, run database schema migration scripts from voyager-evaluate.

npm run migrate

Run the test suite

npm test

Run the service

npm start

You can also run the service against live data in Voyager DB running on Fly.io.

1. Set up a proxy to forward connections to Voyager DB Postgres. Connect to the reader replica running on port 5433 (not 5432).

The command below will forward connections to local post 5455 to Voyager DB's reader replica.

fly proxy 5455:5433 -a voyager-db

2. Start the service and configure the database connection string to use the proxied connection. Look up the user and the password in our shared 1Password vault.

DATABASE_URL="postgres://user:password@localhost:5455/voyager_public" npm start

Deployment

git push