PVD Things API

Environment variables

You'll need to set these environment variables in a .env file at the root of the project folder:

NODE_ENV=development // or 'production'

API_KEY=[value]

AIRTABLE_KEY=[value]
AIRTABLE_BASE_ID=[value]

SUPABASE_URL=[value]
SUPABASE_PUB_ANON_KEY=[value]

// Determines which Discord accounts are allowed to authenticate with the API
DISCORD_WHITELIST="alice@email.com bob@email.com"

// Determines which users can access admin features
ADMIN_WHITELIST="alice@email.com"

// Webhook URL used for sending loan reminder messages
LOAN_REMINDER_WEBHOOK_URL=[value]

// Webhook URL used for updating loan due dates
UPDATE_DUE_DATES_WEBHOOK_URL=[value]

Local Development

Run the server

npm run install // on first run
npm run start

The server will start on port 8088.

When running locally, no authentication is needed for the lending API. In production environments, these endpoints require tokens provided by Supabase Authentication (via Discord).

Documentation

Swagger Docs are hosted at http://localhost:8088/docs.