Skip to content

OpenSourceRaidGuild/Guild-Scrivener

Repository files navigation

Guild-Scrivener's Job

Currently

  • Manages automation of editing & creating labels between repos using one repo as the source of truth.

  • Raid stats coalescing, storage in FireStore & serving to frontend

Environment Setup

Create a .env file

  • FIREBASE_PROJECT_ID This can just be set to raid-stats-c1d5a
  • RAID_HOOK_SECRET The Raid (Stats) Hooks' secret - see GitHub Webhook Secret
  • LABEL_HOOK_SECRET The Label Hooks' secret - see GitHub Webhook Secret
  • AUTH A GitHub Personal Access Token
  • CURRENT_RAID_DISCORD_WEBHOOK_URL The webhook URL for sending "current raid" messages
  • COMPLETED_RAID_DISCORD_WEBHOOK_URL The webhook URL for sending "completed raid" messages
  • PORT optional Only useful for production - not setting this uses port 5000

Commands

firestore

Starts the firestore emulator, and runs the provided script. The emulator is closed once the script has completed.

start

Runs the server - needs to have been built first npm run build

local

Runs dev server on PORT (or 5000 if not set) after starting the firestore emulator

build

Builds the server using tsc

test

Runs Jest in watch mode after starting the firestore emulator

test:ci

Runs Jest while checking coverage